sp_help_jobstep (Transact-SQL)
Devuelve información para los pasos de un trabajo que el servicio del Agente SQL Server utiliza para realizar actividades automatizadas.
.gif "Icono de vínculo a temas")
Sintaxis
sp_help_jobstep { [ @job_id = ] 'job_id' | [ @job_name = ] 'job_name' }
[ , [ @step_id = ] step_id ]
[ , [ @step_name = ] 'step_name' ]
[ , [ @suffix = ] suffix ]
Argumentos
[ @job_id =] 'job_id'
Número de identificación del trabajo para el que se va a devolver información. job_id es de tipo uniqueidentifier y su valor predeterminado es NULL.[ @job_name =] 'job_name'
Nombre del trabajo. job_name es de tipo sysname y su valor predeterminado es NULL.Nota
Se debe especificar job_id o job_name, pero no ambos.
[ @step_id =] step_id
Número de identificación del paso en el trabajo. Si no se especifica, se incluirán todos los pasos del trabajo. step_id es de tipo int y su valor predeterminado es NULL.[ @step_name =] 'step_name'
Nombre del paso en el trabajo. step_name es de tipo sysname y su valor predeterminado es NULL.[ @suffix =] suffix
Indicador que especifica si la salida tiene una descripción de texto anexada a la columna flags. suffixes de tipo bit y su valor predeterminado es 0. Si suffix es 1, hay una descripción anexada.
Valores de código de retorno
0 (correcto) o 1 (error)
Conjuntos de resultados
Nombre de columna |
Tipo de datos |
Descripción |
|---|---|---|
step_id |
int |
Identificador único del paso. |
step_name |
sysname |
Nombre del paso en el trabajo. |
subsystem |
nvarchar(40) |
Subsistema en el que se ejecuta el comando del paso. |
command |
nvarchar(max) |
Comando que se ejecuta en el paso. |
flags |
int |
Máscara de bits que controla el comportamiento del paso. |
cmdexec_success_code |
int |
En un paso CmdExec, código de salida de proceso de un comando ejecutado correctamente. |
on_success_action |
tinyint |
Acción que se realiza si el paso termina correctamente: 1 = Salir del trabajo que se ha ejecutado correctamente. 2 = Salir del trabajo que ha generado errores. 3 = Ir al siguiente paso. 4 = Ir al paso |
on_success_step_id |
int |
Si on_success_action es 4, indica el siguiente paso que se debe ejecutar. |
on_fail_action |
tinyint |
Qué hacer si el paso da error. Los valores son los mismos que para on_success_action. |
on_fail_step_id |
int |
Si on_fail_action es 4, indica el siguiente paso que se debe ejecutar. |
server |
sysname |
Reservado. |
database_name |
sysname |
Para pasos Transact-SQL, la base de datos en que se ejecuta el comando. |
database_user_name |
sysname |
Para pasos Transact-SQL, el contexto de usuario de la base de datos en que se ejecuta el comando. |
retry_attempts |
int |
Número máximo de veces que se vuelve a intentar el comando (si no termina correctamente). |
retry_interval |
int |
Intervalo (en minutos) entre cada nuevo intento. |
os_run_priority |
int |
Reservado. |
output_file_name |
nvarchar(200) |
Archivo en el que se debe escribir la salida del comando (sólo para los pasos Transact-SQL, CmdExec y PowerShell). |
last_run_outcome |
int |
Resultado del paso la última vez que se ejecutó: 0 = No realizado 1 = Realizado 2 = Reintentar 3 = Cancelado 5 = Desconocido |
last_run_duration |
int |
Duración (en segundos) del paso la última vez que se ejecutó. |
last_run_retries |
int |
Número de veces que se ha intentado el comando desde que se ejecutó el paso por última vez. |
last_run_date |
int |
Fecha en que se inició la ejecución del paso por última vez. |
last_run_time |
int |
Hora en que se inició la ejecución del paso por última vez. |
proxy_id |
int |
Proxy del paso de trabajo. |
Comentarios
sp_help_jobstep se encuentra en la base de datos msdb.
Permisos
De manera predeterminada, este procedimiento almacenado lo pueden ejecutar los miembros de la función fija de servidor sysadmin. Al resto de usuarios se les debe conceder una de las siguientes funciones fijas de base de datos del Agente SQL Server en la base de datos msdb:
SQLAgentUserRole
SQLAgentReaderRole
SQLAgentOperatorRole
Para obtener detalles sobre los permisos de estas funciones, vea Funciones fijas de base de datos del Agente SQL Server.
Los miembros de SQLAgentUserRole sólo pueden ver los pasos de los trabajos que les pertenecen.
Ejemplos
A. Devolver información de todos los pasos de un trabajo específico
En el ejemplo siguiente se devuelven todos los pasos del trabajo denominado Weekly Sales Data Backup.
USE msdb ;
GO
EXEC dbo.sp_help_jobstep
@job_name = N'Weekly Sales Data Backup' ;
GO
B. Devolver información acerca de un paso de trabajo específico
En el ejemplo siguiente se devuelve información acerca del primer paso del trabajo denominado Weekly Sales Data Backup.
USE msdb ;
GO
EXEC dbo.sp_help_jobstep
@job_name = N'Weekly Sales Data Backup',
@step_id = 1 ;
GO