Get-SqlAgentJobHistory

  • Referencia
Módulo:
SQLServer

Obtiene el historial de trabajos presente en la instancia de destino del Agente SQL.

Syntax

Get-SqlAgentJobHistory
   [-StartRunDate <DateTime>]
   [-EndRunDate <DateTime>]
   [-JobID <Guid>]
   [-JobName <String>]
   [-MinimumRetries <Int32>]
   [-MinimumRunDurationInSeconds <Int32>]
   [-OldestFirst]
   [-OutcomesType <CompletionResult>]
   [-SqlMessageID <Int32>]
   [-SqlSeverity <Int32>]
   [-Since <SinceType>]
   [[-Path] <String[]>]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [<CommonParameters>]
Get-SqlAgentJobHistory
   [-StartRunDate <DateTime>]
   [-EndRunDate <DateTime>]
   [-JobID <Guid>]
   [-JobName <String>]
   [-MinimumRetries <Int32>]
   [-MinimumRunDurationInSeconds <Int32>]
   [-OldestFirst]
   [-OutcomesType <CompletionResult>]
   [-SqlMessageID <Int32>]
   [-SqlSeverity <Int32>]
   [-Since <SinceType>]
   [[-ServerInstance] <String[]>]
   [-Credential <PSCredential>]
   [-ConnectionTimeout <Int32>]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [<CommonParameters>]
Get-SqlAgentJobHistory
   [-StartRunDate <DateTime>]
   [-EndRunDate <DateTime>]
   [-JobID <Guid>]
   [-JobName <String>]
   [-MinimumRetries <Int32>]
   [-MinimumRunDurationInSeconds <Int32>]
   [-OldestFirst]
   [-OutcomesType <CompletionResult>]
   [-SqlMessageID <Int32>]
   [-SqlSeverity <Int32>]
   [-Since <SinceType>]
   [-InputObject] <JobServer[]>
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [<CommonParameters>]

Description

El cmdlet Get-SqlAgentJobHistory obtiene el objeto JobHistory presente en la instancia de destino del Agente SQL.

Este cmdlet admite los siguientes modos de operación para obtener el objeto JobHistory:

  • Especifique la ruta de acceso de la instancia del Agente SQL.
  • Pase la instancia del Agente SQL en la entrada.
  • Invoque el cmdlet en un contexto válido.

Ejemplos

Ejemplo 1: Obtener todo el historial de trabajos de la instancia de servidor especificada

PS C:\> Get-SqlAgentJobHistory -ServerInstance "MyServerInstance" | Format-Table

InstanceID SqlMessageID Message
---------- ------------ -------
        34            0 The job succeeded.  The Job was invoked by Schedule 8 (syspolicy_purge_history_schedule).  T... 
        33            0 Executed as user: DOMAIN\Machine1$. The step did not generate any output.  Process Exit

Este comando obtiene todo el historial de trabajos de la instancia del servidor denominada MyServerInstance y, a continuación, da formato a la salida.

Ejemplo 2: Obtener el historial de trabajos de la instancia de servidor especificada

PS C:\> Get-SqlAgentJobHistory -ServerInstance "MyServerInstance" -JobID 187112d7-84e1-4b66-b093-e97201c441ed

JobID            : 187112d7-84e1-4b66-b093-e97201c441ed
JobName          : Job_73cc6990-6386-49f9-9826-96c318ad8afa
RunStatus        : 3

Este comando obtiene el historial de trabajos del objeto de trabajo con el identificador '187112d7-84e1-4b66-b093-e97201c441ed' en la instancia de servidor denominada "MyServerInstance".

Ejemplo 3: Obtención del historial de trabajos a partir de una duración de tiempo de la instancia de servidor especificada

PS C:\> Get-SqlAgentJobHistory -ServerInstance "MyServerInstance" -Since Yesterday
InstanceID       : 4
SqlMessageID     : 0
Message          : The job was stopped prior to completion by User admin.  The Job was invoked by User
                   admin.  The last step to run was step 1 (JobStep_3e4cd4ba-3433-4311-a6a2-816884101504).

Este comando devuelve el historial de trabajos desde el día anterior en la instancia del servidor denominada "MyServerInstance".

Parámetros

-AccessToken

Token de acceso que se usa para autenticarse en SQL Server, como alternativa a la autenticación de usuario o contraseña de Windows.

Esto se puede usar, por ejemplo, para conectarse a SQL Azure DB y SQL Azure Managed Instance usar o Service Principal .Managed Identity

El parámetro que se va a usar puede ser una cadena que representa el token o un PSAccessToken objeto tal y como se devuelve mediante la ejecución Get-AzAccessToken -ResourceUrl https://database.windows.netde .

Este parámetro es nuevo en la versión 22 del módulo.

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

-ConnectionTimeout

Especifica el número de segundos que se deben esperar a una conexión de servidor antes de un error de tiempo de espera. El valor de tiempo de espera debe ser un valor entero entre 0 y 65534. Si se especifica 0, los intentos de conexión no tienen tiempo de espera.

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

-Credential

Especifica un objeto PSCredential que se usa para especificar las credenciales de un inicio de sesión de SQL Server que tiene permiso para realizar esta operación.

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

-Encrypt

Tipo de cifrado que se va a usar al conectarse a SQL Server.

Este valor se asigna a la Encrypt propiedad SqlConnectionEncryptOption del objeto SqlConnection del controlador Microsoft.Data.SqlClient.

En la versión 22 del módulo, el valor predeterminado es Optional (por compatibilidad con v21). En la versión 23+ del módulo, el valor predeterminado será "Obligatorio", lo que puede crear un cambio importante para los scripts existentes.

Este parámetro es nuevo en la versión 22 del módulo.

Type:String
Accepted values:Mandatory, Optional, Strict
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EndRunDate

Especifica una restricción de filtro de trabajo que restringe los valores devueltos a la fecha en que se completó el trabajo.

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

-HostNameInCertificate

Nombre de host que se va a usar al validar el certificado TLS/SSL de SQL Server. Debe pasar este parámetro si la instancia de SQL Server está habilitada para Forzar cifrado y desea conectarse a una instancia mediante el nombre de host o el nombre corto. Si se omite este parámetro, es necesario pasar el nombre de dominio completo (FQDN) a -ServerInstance para conectarse a una instancia de SQL Server habilitada para forzar el cifrado.

Este parámetro es nuevo en la versión 22 del módulo.

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

-InputObject

Especifica una matriz de objetos SQL Server Management Object (SMO) que representan el Agente SQL Server de destino.

Type:JobServer[]
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-JobID

Especifica una restricción de filtro de trabajo que restringe los valores devueltos al trabajo especificado por el valor del identificador de trabajo.

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

-JobName

Especifica una restricción de filtro de trabajo que restringe los valores devueltos al trabajo especificado por el nombre del trabajo.

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

-MinimumRetries

Especifica la restricción de filtro de trabajo que restringe los valores devueltos a los trabajos con errores y que se han reintentado durante un número mínimo de veces.

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

-MinimumRunDurationInSeconds

Especifica una restricción de filtro de trabajo que restringe los valores devueltos a los trabajos que se han completado en el período mínimo de tiempo especificado, en segundos.

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

-OldestFirst

Indica que este cmdlet enumera los trabajos en orden más antiguo. Si no especifica este parámetro, el cmdlet usa el orden más reciente.

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

-OutcomesType

Especifica una restricción de filtro de trabajo que restringe los valores devueltos a los trabajos que tienen el resultado especificado al finalizar.

Los valores permitidos para este parámetro son los siguientes:

-- Failed -- Succeeded -- Retry -- Cancelled -- InProgress -- Unknown

Type:CompletionResult
Accepted values:Failed, Succeeded, Retry, Cancelled, InProgress, Unknown
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Path

Especifica la ruta de acceso al agente de SQL Server, como una matriz, en la que este cmdlet ejecuta la operación. Si no especifica un valor para este parámetro, el cmdlet usa la ubicación de trabajo actual.

Type:String[]
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ServerInstance

Especifica el nombre de una instancia de SQL Server, como una matriz, donde se ejecuta el Agente SQL. Para las instancias predeterminadas, especifique solo el nombre del equipo: MyComputer. Para las instancias con nombre, use el formato NombreDeEquipo\NombreDeInstancia.

Type:String[]
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Since

Especifica una abreviatura que se puede usar en lugar del parámetro StartRunDate.

Se puede especificar con el parámetro EndRunDate.

No puede usar el parámetro StartRunDate si usa este parámetro.

Los valores permitidos para este parámetro son los siguientes:

  • Medianoche (obtiene toda la información del historial de trabajos generada después de medianoche)
  • Ayer (obtiene toda la información del historial de trabajos generada en las últimas 24 horas)
  • LastWeek (obtiene toda la información del historial de trabajos generada en la última semana)
  • LastMonth (obtiene toda la información del historial de trabajos generada en el último mes)
Type:SinceType
Accepted values:Midnight, Yesterday, LastWeek, LastMonth
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SqlMessageID

Especifica una restricción de filtro de trabajo que restringe los valores devueltos a los trabajos que han generado el mensaje especificado durante el tiempo de ejecución.

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

-SqlSeverity

Especifica una restricción de filtro de trabajo que restringe los valores devueltos a los trabajos que han generado un error de la gravedad especificada durante el tiempo de ejecución.

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

-StartRunDate

Especifica una restricción de filtro de trabajo que restringe los valores devueltos a la fecha en que se inició el trabajo.

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

-TrustServerCertificate

Indica si el canal se cifrará al pasar la cadena de certificados para validar la confianza.

En la versión 22 del módulo, el valor predeterminado es $true (por compatibilidad con v21). En la versión 23 y posteriores del módulo, el valor predeterminado será "$false", lo que puede crear un cambio importante para los scripts existentes.

Este parámetro es nuevo en la versión 22 del módulo.

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

Entradas

System.String[]

Microsoft.SqlServer.Management.Smo.Agent.JobServer[]

Salidas

System.Object