Start-SmaRunbook

Artikel
11/25/2015

Start-SmaRunbook

Starts a runbook job.

Syntax

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

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

Detaillierte Beschreibung

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 web service.

Parameter

-AuthenticationType<String>

Specifies the authentication type. Valid values are: Basic, Windows.

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

Aliasse	Keiner
Erforderlich?	false
Position?	named
Standardwert	Windows
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-Credential<PSCredential>

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

Aliasse	Keiner
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-Id<String>

Specifies the ID of a runbook.

Aliasse	RunbookId
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	True (ByValue)
Platzhalterzeichen akzeptieren?	false

-Name<String>

Specifies the name of a runbook.

Aliasse	RunbookName
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	True (ByValue)
Platzhalterzeichen akzeptieren?	false

-Parameters<IDictionary>

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

Aliasse	Keiner
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-Port<Int32>

Specifies the port number of the web service.

Aliasse	Keiner
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-ScheduleName<String>

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

Aliasse	Keiner
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-WebServiceEndpoint<String>

Specifies the endpoint, as a URL, of the web service. Include the protocol, for example, http:// or https://.

Aliasse	Keiner
Erforderlich?	true
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-Confirm

Sie werden vor dem Ausführen des Cmdlets zur Bestätigung aufgefordert.

Erforderlich?	false
Position?	named
Standardwert	falsch
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-WhatIf

Zeigt, was geschieht, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

Erforderlich?	false
Position?	named
Standardwert	falsch
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

<CommonParameters>

Dieses Cmdlet unterstützt die allgemeinen Parameter: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, -OutVariable. Weitere Informationen finden Sie unter about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Eingaben

Der Eingabetyp ist der Typ der Objekte, die über die Pipeline an das Cmdlet übergeben werden können.

Ausgaben

Der Ausgabetyp ist der Typ der Objekte, die vom Cmdlet ausgegeben werden.

Beispiele

Example 1: Start a runbook job

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

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

Freigeben über

Start-SmaRunbook