Compartir vía

sp_help_jobstep (Transact-SQL)

  • Artículo

Se aplica a: SQL Server

Devuelve información de los pasos de un trabajo usado por Agente SQL Server servicio para realizar actividades automatizadas.

Convenciones de sintaxis de Transact-SQL

Sintaxis

sp_help_jobstep
    [ [ @job_id = ] 'job_id' ]
    [ , [ @job_name = ] N'job_name' ]
    [ , [ @step_id = ] step_id ]
    [ , [ @step_name = ] N'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 del trabajo. @job_id es uniqueidentifier, con un valor predeterminado de NULL.

Se deben especificar @job_id o @job_name , pero no se pueden especificar ambos.

[ @job_name = ] N'job_name'

Nombre del trabajo. @job_name es sysname, con un valor predeterminado de NULL.

Se deben especificar @job_id o @job_name , pero no se pueden especificar 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 int, con un valor predeterminado de NULL.

[ @step_name = ] N'step_name'

Nombre del paso en el trabajo. @step_name es sysname, con un valor predeterminado de NULL.

[ @suffix = ] sufijo

Marca que indica si se anexa una descripción de texto a la columna flags de la salida. @suffix es bit, con un valor predeterminado de 0. Si @sufijo es 1, se anexa una descripción.

Valores de código de retorno

0 (correcto) o 1 (erróneo).

Conjunto de resultados

Nombre de la 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 Para un paso cmdExec , este valor es el código de salida del proceso de un comando correcto.
on_success_action tinyint Acción que se realiza si el paso termina correctamente:

1 = Salga del trabajo informando de que se ha realizado correctamente.
2 = Salga del error de notificación del trabajo.
3 = Vaya al paso siguiente.
4 = Ir al paso.
on_success_step_id int Si on_success_action es 4, este valor indica el paso siguiente que se va a ejecutar.
on_fail_action tinyint Qué hacer si el paso da error. Los valores son iguales que on_success_action.
on_fail_step_id int Si on_fail_action es 4, este valor indica el paso siguiente que se va a ejecutar.
server sysname Reservado.
database_name sysname Para un paso de Transact-SQL, este valor es la base de datos en la que se ejecuta el comando.
database_user_name sysname Para un paso de Transact-SQL, este valor es el contexto de usuario de la base de datos en el que se ejecuta el comando.
retry_attempts int Número máximo de veces que se debe reintentar el comando (si no se realiza 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 (solo pasos de Transact-SQL, CmdExec y PowerShell ).
last_run_outcome int Resultado del paso la última vez que se ejecutó:

0 = Error
1 = Correcto
2 = Reintento
3 = Cancelado
5 = Desconocido
last_run_duration int Duración (hhmmss) 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 está en la base de msdb datos.

Permisos

Este procedimiento almacenado es propiedad del rol db_owner . Puede conceder EXECUTE permisos para cualquier usuario, pero estos permisos se pueden invalidar durante una actualización de SQL Server.

A otros usuarios se les debe conceder uno de los siguientes Agente SQL Server roles fijos de base de datos en la msdb base de datos:

  • SQLAgentUserRole
  • SQLAgentReaderRole
  • SQLAgentOperatorRole

Para detalles sobre los permisos de estos roles, consulte Roles fijos de base de datos del Agente SQL Server.

Los miembros de SQLAgentUserRole solo pueden ver los pasos de trabajo de los trabajos que poseen.

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

Contenido relacionado