sp_help_jobstep (Transact-SQL)

Article
08/19/2013

Renvoie des informations sur les étapes d'un travail utilisé par le service SQL Server Agent pour procéder à des actions automatisées.

Icône Lien de rubrique Conventions de la syntaxe Transact-SQL

Syntaxe

sp_help_jobstep { [ @job_id = ] 'job_id' | [ @job_name = ] 'job_name' }
     [ , [ @step_id = ] step_id ] 
     [ , [ @step_name = ] 'step_name' ] 
     [ , [ @suffix = ] suffix ]

Arguments

[ @job_id =] 'job_id'
Numéro d'identification du travail pour lequel renvoyer des informations. job_id est de type uniqueidentifier, avec NULL comme valeur par défaut.
[ @job_name =] 'job_name'
Nom du travail. job_name est de type sysname, avec NULL comme valeur par défaut.

[!REMARQUE]

Vous devez définir la valeur de job_id ou de job_name, mais pas les deux valeurs à la fois.
[ @step_id =] step_id
Numéro d'identification de l'étape du travail. S'il n'est pas inclus, toutes les étapes du travail sont englobées. step_id est de type int, avec NULL comme valeur par défaut.
[ @step_name =] 'step_name'
Nom de l'étape du travail. step_name est de type sysname, avec NULL comme valeur par défaut.
[ @suffix =] suffix
Indicateur spécifiant si une description de texte est appliquée à la colonne indicateurs dans le résultat. suffixest de type bit, avec 0 comme valeur par défaut. Si la valeur de suffix est définie sur 1, une description est appliquée.

Valeurs des codes renvoyés

0 (réussite) ou 1 (échec)

Jeux de résultats

Nom de colonne	Type de données	Description
step_id	int	Identificateur unique de l'étape.
step_name	sysname	Nom de l'étape du travail.
subsystem	nvarchar(40)	Sous-système dans lequel la commande d'étape doit être exécutée.
commande	nvarchar(max)	Commande exécutée dans l'étape.
flags	int	Masque de bits des valeurs qui contrôle le comportement de l'étape.
cmdexec_success_code	int	Pour une étape CmdExec, il s'agit du code de sortie d'une commande exécutée correctement.
on_success_action	tinyint	Action à effectuer si l'étape est exécutée correctement : 1 = Quitter le travail rapportant une réussite. 2 = Quitter le travail rapportant un échec. 3 = Passer à l'étape suivante. 4 = Passer à l'étape.
on_success_step_id	int	Si on_success_action possède la valeur 4, ce paramètre indique la prochaine étape qui doit être exécutée.
on_fail_action	tinyint	Action à exécuter si l'étape échoue. Les valeurs sont les mêmes que pour on_success_action.
on_fail_step_id	int	Si on_fail_action possède la valeur 4, ce paramètre indique la prochaine étape qui doit être exécutée.
server	sysname	Réservé.
database_name	sysname	Pour une étape Transact-SQL, c'est la base de données dans laquelle la commande est exécutée.
database_user_name	sysname	Pour une étape Transact-SQL, c'est le contexte de l'utilisateur de la base de données dans lequel la commande est exécutée.
retry_attempts	int	Nombre maximum de tentatives de la commande (en cas d'échecs).
retry_interval	int	Intervalle (en minutes) entre les tentatives.
os_run_priority	int	Réservé.
output_file_name	nvarchar(200)	Fichier dans lequel la sortie de la commande doit être écrite (étapes Transact-SQL, CmdExec et PowerShell uniquement).
last_run_outcome	int	Résultat de l'étape lors de sa dernière exécution. 0 = Échec 1 = Réussite 2 = Reprise 3 = Annulation 5 = Inconnu
last_run_duration	int	Durée (en secondes) de l'étape lors de sa dernière exécution.
last_run_retries	int	Nombre de tentatives de la commande lors de la dernière exécution de l'étape.
last_run_date	int	Date de début de la dernière exécution de l'étape.
last_run_time	int	Heure de début de la dernière exécution de l'étape.
proxy_id	int	Proxy de l'étape du travail.

Notes

sp_help_jobstep se trouve dans la base de données msdb.

Autorisations

Seuls les membres du rôle de serveur fixe sysadmin peuvent exécuter cette procédure stockée. Les autres utilisateurs doivent disposer de l'un des rôles de base de données fixes SQL Server Agent suivants dans la base de données msdb.

SQLAgentUserRole
SQLAgentReaderRole
SQLAgentOperatorRole

Pour en savoir plus sur les autorisations de ces rôles, consultez Rôles de base de données fixes de l'Agent SQL Server.

Les membres du rôle SQLAgentUserRole peuvent consulter uniquement les étapes de travail des travaux dont ils sont propriétaires.

Exemples

A.Renvoi d'informations sur toutes les étapes d'un travail spécifique

L'exemple suivant renvoie toutes les étapes du travail intitulé Weekly Sales Data Backup.

USE msdb ;
GO

EXEC dbo.sp_help_jobstep
    @job_name = N'Weekly Sales Data Backup' ;
GO

B.Renvoi d'informations sur une étape spécifique d'un travail

Cet exemple renvoie des informations sur la première étape du travail Weekly Sales Data Backup.

USE msdb ;
GO

EXEC dbo.sp_help_jobstep
    @job_name = N'Weekly Sales Data Backup',
    @step_id = 1 ;
GO

Voir aussi

Référence

sp_add_jobstep (Transact-SQL)

sp_delete_jobstep (Transact-SQL)

sp_help_job (Transact-SQL)

sp_update_jobstep (Transact-SQL)

Procédures stockées système (Transact-SQL)

Partager via