Partager via


Start-SmaRunbook

Démarre un travail de runbook.

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

L’applet de commande Start-SmaRunbook démarre une tâche de runbook. Spécifiez l’ID ou le nom d’un runbook et du point de terminaison de service web. Si nécessaire, spécifiez le port du service web Service Management Automation (SMA).

Exemples

Exemple 1 : Démarrer un travail de runbook

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

Cette commande démarre le runbook nommé Runbk01, en spécifiant les paramètres du travail du runbook.

Paramètres

-AuthenticationType

Spécifie le type d’authentification. Les valeurs autorisées sont :

  • De base
  • Windows

La valeur par défaut de ce paramètre est Windows. Si vous utilisez l’authentification de base, vous devez fournir des informations d’identification à l’aide du paramètre Credential .

Type:String
Accepted values:Basic, Windows
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Vous demande une confirmation avant d’exécuter l’applet de commande.

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

-Credential

Spécifie un objet PSCredential pour la connexion au service web SMA. Pour obtenir un objet d’informations d’identification, utilisez l’applet de commande Get-Credential. Pour plus d'informations, voir Get-Help Get-Credential.

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

-Id

Spécifie l’ID d’un runbook.

Type:String
Aliases:RunbookId
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

Spécifie le nom d’un runbook.

Type:String
Aliases:RunbookName
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Parameters

Spécifie une table de hachage de paires clé et valeur. Les clés de la table de hachage sont les noms des paramètres de runbook. Les valeurs de la table de hachage sont les valeurs des paramètres du runbook.

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

-Port

Spécifie le numéro de port du service web SMA.

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

-ScheduleName

Spécifie le nom d’une planification de travail sur laquelle démarrer le runbook. Pour créer une planification dans SMA, utilisez l’applet de commande Set-SmaSchedule.

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

-WebServiceEndpoint

Spécifie le point de terminaison, en tant qu’URL, du service web SMA. Vous devez inclure le protocole, par exemple, http:// ou https://.

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

-WhatIf

Montre ce qui se passe en cas d’exécution de l’applet de commande. L’applet de commande n’est pas exécutée.

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