Administrar runbooks para Service Management AutomationManage runbooks for Service Management Automation

Se aplica a: System Center 2016 - Service Management AutomationApplies To: System Center 2016 - Service Management Automation

Como administrador de una instalación de Service Management Automation (SMA), debe configurar los runbooks para su ejecución.As an administrator of a Service Management Automation (SMA) installation, you will need to configure runbooks for execution. La configuración incluye tanto la instalación inicial de los trabajadores de runbook, así como runbooks de programación y seguimiento.Configuring includes both initial setup of the runbook workers, as well as scheduling and tracking runbooks. Hay dos runbooks del sistema que se incluyen con SMA además de los runbooks que se han creado.There are two system runbooks that are included with SMA in addition to the runbooks you have authored. Estos son:These are:

  • DiscoverAllLocalModules: Se ejecuta inmediatamente después de instalar a un runbook worker.DiscoverAllLocalModules: Runs immediately after you install a runbook worker. Este runbook detecta todos los módulos nativos en el sistema de Windows Server donde se ha instalado el runbook worker y extrae las actividades y los metadatos de actividad de estos módulos para que sus actividades se pueden usar al crear runbooks en Windows Azure Pack.This runbook discovers all native modules on the Windows Server system where the runbook worker has been installed, and extracts activities and activity metadata for these modules so that their activities can be used when authoring runbooks in Windows Azure Pack.

  • SetAutomationModuleActivityMetadata: Se ejecuta inmediatamente después de importar un módulo en Service Management Automation.SetAutomationModuleActivityMetadata: Runs immediately after you import a module into Service Management Automation. Este runbook extrae las actividades y los metadatos de actividad de un módulo recién importado para que sus actividades se pueden usar al crear runbooks en Windows Azure Pack.This runbook extracts activities and activity metadata from a newly imported module so that its activities can be used when authoring runbooks in Windows Azure Pack.

Configuración de los trabajadores de runbookConfiguring runbook workers

Cuando se inicia un trabajo de runbook en Service Management Automation, de forma predeterminada, se selecciona por un runbook worker seleccionado aleatoriamente.When you start a runbook job in Service Management Automation, by default, it is picked by a runbook worker selected at random. Sin embargo, en ocasiones, puede ejecutar un runbook en un trabajo de runbook determinado por distintas razones.However, sometimes you might want to run a runbook against a particular runbook worker for various reasons. Propiedad de configuración de RunbookWorker le ayuda a lograr.RunbookWorker configuration property helps you achieve that. Para obtener más información sobre cómo se ejecutan los runbooks, vea ejecución de un Runbook en Service Management Automation.For more information on how runbooks are executed, see Runbook Execution in Service Management Automation.

Designar un runbook worker mediante el complemento de PowerShell ISE.Designating a runbook worker through the PowerShell ISE Add-on.

  • En el ISE el SMA Add-On, bajo la configuración ficha, inicie sesión con su cuenta de SMA.In the SMA ISE Add-on, under the Configuration tab, sign in using your SMA account.
  • En el inicio de sesión correcto, puede ver sus runbooks en el Runbooks ficha.On successful login, you can see your runbooks in the Runbooks tab.
  • En el Runbooks ficha, seleccione uno o más runbooks que desea que se ejecuta en un trabajo de runbook determinado.In the Runbooks tab, select one or more runbooks which you want to be executed against a particular runbook worker.
  • Haga clic en configurar botón en el panel inferior.Click on configure button in the bottom pane.
  • En el Runbook configurar propiedades cuadro de diálogo, seleccione un runbook worker en el menú desplegable.In the Configure Runbook properties dialog, select a runbook worker from the drop-down menu. Haga clic en realizar cambios.Click Make changes.

Designar un runbook worker mediante el módulo de PowerShell de SMADesignating a runbook worker through the SMA PowerShell module

También puede establecer la propiedad de trabajo de runbook con el comando siguiente para hacer lo mismo a través de la línea de comandosYou can also set the runbook worker property using the following command to do the same via command line

$webServer = 'https://MyServer'
$port = 9090
$runbookName = "Sample-TestRunbook"
$workerName = "Worker1"

Set-SmaRunbookConfiguration -WebServiceEndpoint $webServer -Port $port -Name $runbookName -RunbookWorker $workerName

Puede ver una lista de todos los trabajadores de runbook que se implementan utilizando el siguiente comando.You can see a list of all the runbook workers deployed using the following command.

$webServer = 'https://MyServer'
$port = 9090

Get-SmaRunbookWorkerDeployment -WebServiceEndpoint $webServer -Port $port
Nota

Actualmente, no se puede usar el portal de Windows Azure Pack para designar un runbook worker.Currently, you can not use Windows Azure Pack portal to designate a runbook worker. Usar los cmdlets SMA ISE Add-on o PowerShell para hacerlo.Use either the SMA ISE Add-on or PowerShell cmdlets to do it.

Programar runbooksScheduling runbooks

Para programar un runbook en Service Management Automation para iniciar en un momento determinado, vincúlelo a una o más programaciones.To schedule a runbook in Service Management Automation to start at a specified time, you link it to one or more schedules. Una programación puede configurarse para ejecutarse una vez o de manera periódica cada cierto número de días.A schedule can be configured to either run one time or recurring every specified number of days. Un Runbook puede vincularse a varias programaciones y una programación puede tener varios Runbooks vinculados.A runbook can be linked to multiple schedules, and a schedule can have multiple runbooks linked to it.

Crear una programaciónCreating a schedule

Puede crear una nueva programación con el Portal de administración o con Windows PowerShell.You can either create a new schedule with the Management Portal or with Windows PowerShell. También tiene la opción de crear una nueva programación al vincular un Runbook a una programación mediante el Portal de administración.You also have the option of creating a new schedule when you link a runbook to a schedule using the Management Portal.

Para crear una nueva programación con el Portal de administraciónTo create a new schedule with the Management Portal

  1. En el Portal de administración, seleccione Automatización.In the Management Portal, select Automation.

  2. Seleccione la pestaña Activos .Select the Assets tab.

  3. En la parte inferior de la ventana, haga clic en Agregar configuración.At the bottom of the window, click Add Setting.

  4. Haga clic en Agregar programación.Click Add Schedule.

  5. Escriba un Nombre y, de manera opcional, una Descripción para la nueva programación.Type a Name and optionally a Description for the new schedule.

  6. Seleccione si la programación se ejecutará Una vez o Diario.Select whether the schedule will run One Time or Daily.

  7. Especifique una Hora de inicio y las demás opciones según el tipo de programación que seleccione.Specify a Start Time and the other options depending on the type of schedule that you selected. La zona horaria de la hora de inicio se corresponderá con la zona horaria del equipo local.The time zone of the start time will match the time zone of the local computer.

Para crear una nueva programación con Windows PowerShellTo create a new schedule with Windows PowerShell

Puede usar el Set-SmaSchedule cmdlet para crear una nueva programación o modificar una programación existente en la automatización.You can use the Set-SmaSchedule cmdlet to create a new schedule or modify an existing schedule in Automation. Debe especificar la hora de inicio de la programación y si debe ejecutarse una vez o diariamente.You must specify the start time for the schedule and whether it should run one time or daily.

Los siguientes comandos de muestra de Windows PowerShell crean una nueva programación denominada My Daily Schedule, que comienza en el día actual y continúa cada día al mediodía durante un año.The following sample Windows PowerShell commands create a new schedule called My Daily Schedule that starts on the current day and continues for one year every day at noon.

$webServer = 'https://MyServer'
$port = 9090
$scheduleName = 'My Daily Schedule'
$startTime = (Get-Date).Date.AddHours(12)
$expiryTime = $startTime.AddYears(1)

Set-SmaSchedule "WebServiceEndpoint $webServer "Port $port "Name $scheduleName "ScheduleType OneTimeSchedule "StartTime $startTime "ExpiryTime $expiryTime "DayInterval 1

Vincular una programación a un runbookLinking a schedule to a runbook

Un Runbook puede vincularse a varias programaciones y una programación puede tener varios Runbooks vinculados.A runbook can be linked to multiple schedules, and a schedule can have multiple runbooks linked to it. Si un Runbook tiene parámetros, puede proporcionar valores para estos que se utilicen al iniciar el Runbook.If a runbook has parameters, then you can provide values for them that are used when the runbook is started. Debe proporcionar valores para todos los parámetros obligatorios.You must provide values for any mandatory parameters.

  1. En el Portal de administración, seleccione Automatización.In the Management Portal, select Automation.

  2. Seleccione la pestaña Runbooks .Select the Runbooks tab.

  3. Haga clic en el nombre del Runbook que desea programar.Click on the name of the runbook to schedule.

  4. Haga clic en la pestaña Programación .Click the Schedule tab.

  5. Si el Runbook está vinculado actualmente a una programación,If the runbook is currently linked to a schedule,.

  6. haga clic en Vincular en la parte inferior de la ventana.Click Link at the bottom of the window. A continuación, haga clic en Vincular a una programación nueva y siga las instrucciones del cuadro de diálogo para crear una nueva programación, o bien haga clic en Vincular a una programación existente y seleccione una programación que ya esté creada.Then either click Link to a New Schedule and follow the dialog box to create a new schedule, or click Link to an Existing Schedule and select a schedule that has already been created.

  7. Si el Runbook tiene parámetros, se le pedirán sus valores.If the runbook has parameters, you will be prompted for their values.

Puede utilizar Start-SmaRunbook con el parámetro ScheduleName para vincular una programación a un Runbook.You can use the Start-SmaRunbook with the ScheduleName parameter to link a schedule to a runbook. Puede especificar valores para el runbook "parámetros de s con el parámetros parámetro.You can specify values for the runbook"s parameters with the Parameters parameter. Vea a partir de un Runbook para obtener más información sobre cómo especificar valores de parámetro.See Starting a Runbook for more information on specifying parameter values.

Los siguientes comandos de ejemplo muestran cómo vincular una programación a un Runbook.The following sample commands show how to link a schedule to a runbook.

$webServer = 'https://MyServer'
$port = 9090
$runbookName = "Test-Runbook"
$scheduleName = "Sample-DailySchedule"

Start-SmaRunbook "WebServiceEndpoint $webServer "Port $port "Name $runbookName "ScheduleName $scheduleName "Parameters $params

Runbooks de seguimientoTracking runbooks

Cuando se inicia un runbook en Service Management Automation, se crea un trabajo.When you start a runbook in Service Management Automation, a job is created. Un trabajo es una única instancia de ejecución de un Runbook.A job is a single execution instance of a runbook. Un único runbook puede tener varios trabajos, cada uno con su propio conjunto de valores para el runbook "parámetros s.A single runbook may have multiple jobs, each with their own set of values for the runbook"s parameters.

Si se rellena la propiedad RunbookWorker del runbook, ese servidor Worker atenderá el trabajo.If the RunbookWorker property of the runbook is populated, then that Worker server will service the job. Si el servidor de trabajo no está disponible, a continuación, el trabajo se producirá un error.If the Worker server is not available, then the job will fail with an error. Si no se rellena la propiedad RunbookWorker del runbook, SMA selecciona aleatoriamente un servidor de trabajador disponible para atender la solicitud.If the RunbookWorker property of the runbook is not populated, then SMA will randomly select an available Worker server to service the request.

El siguiente diagrama muestra el ciclo de vida de un trabajo de runbook de runbooks de flujo de trabajo de PowerShell.The following diagram shows the lifecycle of a runbook job for PowerShell Workflow runbooks.

Estados de trabajo: flujo de trabajo de PowerShell

El siguiente diagrama muestra el ciclo de vida de un trabajo de runbook de runbooks de la secuencia de comandos de PowerShell.The following diagram shows the lifecycle of a runbook job for PowerShell script runbooks.

Estados de trabajo - Script de PowerShell

Estados de trabajoJob statuses

En la tabla siguiente se describen los diferentes estados posibles de un trabajo.The following table describes the different statuses that are possible for a job.

EstadoStatus DescripciónDescription
CompletadosCompleted El trabajo se completó correctamente.The job completed successfully.
Con errorFailed El trabajo finalizó con una excepción.The job ended with an exception.
En colaQueued El trabajo está esperando que los recursos de un trabajador de automatización estén disponibles para poder iniciarse.The job is waiting for resources on an Automation worker to come available so that it can be started.
IniciandoStarting El trabajo se ha asignado a un trabajador y el sistema lo está iniciando.The job has been assigned to a worker, and the system is in the process of starting it.
ReanudandoResuming El sistema está reanudando el trabajo que estaba suspendido.The system is in the process of resuming the job after it was suspended.
En ejecuciónRunning El trabajo se está ejecutando.The job is running.
DetenidoStopped El usuario detuvo el trabajo antes de que se completara.The job was stopped by the user before it was completed.
DeteniendoStopping El sistema está deteniendo el trabajo.The system is in the process of stopping the job.
SuspendidoSuspended El usuario, el sistema o un comando suspendieron el trabajo en el Runbook.The job was suspended by the user, by the system, or by a command in the runbook. Un trabajo que está suspendido se puede iniciar de nuevo y se reanudará desde el último punto de control o desde el principio del Runbook si no tiene ninguno.A job that is suspended can be started again and will resume from its last checkpoint or from the beginning of the runbook if it has no checkpoints.

El sistema solo suspenderá el Runbook en el caso de una excepción si existe una posibilidad de reanudarlo.The runbook will only be suspended by the system in the case of an exception where there is a possibility of resuming. De forma predeterminada, ErrorActionPreference está establecido en continuar lo que significa que el trabajo seguirá ejecutándose en una excepción.By default, ErrorActionPreference is set to Continue meaning that the job will keep running on an exception. Si se establece esta variable de preferencia en Stop , el trabajo se suspenderá si se produce una excepción.If this preference variable is set to Stop then the job will suspend on an exception.
SuspendiendoSuspending El sistema está intentando suspender el trabajo a petición del usuario.The system is attempting to suspend the job at the request of the user. El Runbook debe alcanzar el siguiente punto de control para que se pueda suspender.The runbook must reach its next checkpoint before it can be suspended. Si ya ha pasado el último punto de control, se completará antes de que se pueda suspender.If it has already passed its last checkpoint, then it will complete before it can be suspended.

Visualización del estado de trabajo mediante el Portal de administraciónViewing job status using the Management Portal

El panel de automatización muestra un resumen de todos los runbooks en el entorno de Service Management Automation.The Automation Dashboard shows a summary of all of the runbooks in the Service Management Automation environment. El gráfico de resumen muestra el número total de trabajos de todos los Runbooks que entran en cada estado durante un número determinado de días u horas.The summary graph shows the number of total jobs for all runbooks that entered each status over a given number of days or hours. Puede seleccionar el intervalo de tiempo en la esquina superior derecha del gráfico.You can select the time range on the top right corner of the graph. El eje de tiempo del gráfico cambiará según el tipo de intervalo de tiempo que seleccione.The time axis of the chart will change according to the type of time range that you select. Para elegir si desea mostrar la línea de un estado determinado, haga clic en el estado en la parte superior de la pantalla.You can choose whether to display the line for a particular status by clicking on it at the top of screen.

Puede utilizar los pasos siguientes para que se muestre el panel de automatización.You can use the following steps to display the Automation Dashboard.

  1. En el Portal de administración, seleccione Automatización.In the Management Portal, select Automation.

  2. Seleccione la ficha Panel .Select the Dashboard tab.

Panel de runbookRunbook dashboard

El panel de Runbook muestra un resumen de un único Runbook.The Runbook Dashboard shows a summary for a single runbook. El gráfico de resumen muestra el número total de trabajos del Runbook que entra en cada estado durante un número determinado de días u horas.The summary graph shows the number of total jobs for the runbook that entered each status over a given number of days or hours. Puede seleccionar el intervalo de tiempo en la esquina superior derecha del gráfico.You can select the time range on the top right corner of the graph. El eje de tiempo del gráfico cambiará según el tipo de intervalo de tiempo que seleccione.The time axis of the chart will change according to the type of time range that you select. Para elegir si desea mostrar la línea de un estado determinado, haga clic en el estado en la parte superior de la pantalla.You can choose whether to display the line for a particular status by clicking on it at the top of screen.

Puede utilizar los pasos siguientes para que se muestre el panel de Runbook.You can use the following steps to display the Runbook Dashboard.

  1. En el Portal de administración, seleccione Automatización.In the Management Portal, select Automation.

  2. Haga clic en el nombre de un Runbook.Click the name of a runbook.

  3. Seleccione la ficha Panel .Select the Dashboard tab.

Origen, el historial y el resumen de trabajosJob summary, history, and source

Puede ver una lista de todos los trabajos que se han creado para un Runbook determinado y su estado más reciente.You can view a list of all of the jobs that have been created for a particular runbook and their most recent status. Esta lista se puede filtrar por el estado del trabajo y el intervalo de fechas del último cambio realizado en el trabajo.You can filter this list by job status and the range of dates for the last change to the job. Haga clic en el nombre de un trabajo para ver la información detallada y el resultado correspondientes.Click on the name of a job to view its detailed information and its output. La vista detallada del trabajo incluye los valores de los parámetros del Runbook que se proporcionaron para dicho trabajo.The detailed view of the job includes the values for the runbook parameters that were provided to that job.

El historial de trabajos incluye mensajes de salida, advertencia y error con marcas de tiempo de cuando se creó el registro.The job history includes output, warning, and error messages with time stamps of when the record was created. Para obtener más información sobre los registros que se escriben en el historial de trabajos, consulte Runbook Output and Messages.For more information on records that are written to the job history, see Runbook Output and Messages.

El origen de un trabajo es el código de origen del flujo de trabajo cuando se ejecutó el trabajo.The source for a job is the source code of the workflow when the job was run. Es posible que no coincida con la versión actual del Runbook si se actualizó después de ejecutar el trabajo.This may not be the same as the current version of the runbook if it was updated after the job was run.

Puede realizar los pasos siguientes para ver los trabajos de un Runbook.You can use the following steps to view the jobs for a runbook.

  1. En el Portal de administración, seleccione Automatización.In the Management Portal, select Automation.

  2. Haga clic en el nombre de un Runbook.Click the name of a runbook.

  3. Seleccione la pestaña Trabajos .Select the Jobs tab.

  4. Haga clic en la columna Trabajo creado de un trabajo ver sus detalles y el resultado.Click on the Job Created column for a job to view its detail and output.

  5. Seleccione la pestaña Historial para ver el historial de trabajos.Select the History tab to view the job history. Seleccione un registro de historial y haga clic en Ver detalles en la parte inferior de la pantalla para obtener una vista detallada del registro.Select a history record and click View Details at the bottom of the screen for a detailed view of the record.

  6. Desde la pestaña Historial , haga clic en Ver origen en la parte inferior de la pantalla para ver el origen del trabajo.From the History tab, click View Source at the bottom of the screen to the source for the job.

Recuperar el estado de trabajo con Windows PowerShellRetrieving job status using Windows PowerShell

Puede utilizar Get-SmaJob para recuperar los trabajos creados para un Runbook y los detalles de un trabajo determinado.You can use the Get-SmaJob to retrieve the jobs created for a runbook and the details of a particular job. Si inicia un Runbook con Windows PowerShell mediante Start-SmaRunbook, devolverá el trabajo resultante.If you start a runbook with Windows PowerShell using Start-SmaRunbook, then it will return the resulting job. Use Get-SmaJobOutput para obtener un trabajo "s una salida.Use Get-SmaJobOutput to get a job"s output.

Los comandos de muestra siguientes recuperan el último trabajo de un Runbook de muestra, y muestran su estado, los valores proporcionados para los parámetros del Runbook y el resultado del trabajo.The following sample commands retrieves the last job for a sample runbook and displays its status, the values provide for the runbook parameters, and the output from the job.

$webServer = 'https://MyServer'
$port = 9090
$runbookName = "Test-Runbook"

$job = (Get-SmaJob "WebServiceEndpoint $webServer "Port $port "RunbookName $runbookName | sort LastModifiedDate "desc)[0]
$job.Status
$job.JobParameters
Get-SmaJobOutput "WebServiceEndpoint $webServer "Port $port -Id $job.Id "Stream Output

Configurar el runbookConfigure runbook settings

Cada runbook de automatización de la administración de servicio tiene varias opciones de configuración.Each runbook in Service Management Automation has multiple settings. Puede usar esta configuración para ayudar a localizar y administrar runbooks.You can use these settings to help locate and manage runbooks. También puede cambiar el registro de runbook mediante la configuración de estos valores.You also can change runbook logging by configuring these settings. Todas estas opciones se describen a continuación con procedimientos sobre cómo modificarlas.Each of these settings is described below followed by procedures on how to modify them.

Nombre y descripciónName and description

No se puede cambiar el nombre de un Runbook después de su creación.You cannot change the name of a runbook after it has been created. El campo Descripción es opcional y puede tener hasta 512 caracteres.The Description is optional and can be up to 512 characters.

EtiquetasTags

Las etiquetas permiten asignar diferentes palabras y frases para facilitar la identificación de un Runbook.Tags allow you to assign distinct words and phrases to help identify a runbook. Para especificar varias etiquetas para un Runbook, sepárelas con comas.You can specify multiple tags for a runbook by separating them with commas.

RegistroLogging

De forma predeterminada, los registros detallado y de progreso no se escriben en el historial de trabajos.By default, Verbose and Progress records are not written to job history. Puede cambiar la configuración de un Runbook determinado para estas entradas de registro.You can change the settings for a particular runbook to log these records. Para obtener más información sobre estos registros, vea Runbook Output and Messages.For more information on these records, see Runbook Output and Messages.

Trabajo de runbook designadoDesignated runbook worker

De forma predeterminada, un trabajo de runbook se asignará a un trabajador runbook aleatorio para ejecutar.By default, a runbook job will be assigned to a random runbook worker to execute. Puede cambiar la configuración de un runbook determinado para ejecutar el runbook en un runbook determinado de trabajo.You can change settings for a particular runbook to execute the runbook on a particular runbook worker.

Cambiar la configuración de un runbook con el Portal de administraciónChanging runbook settings with the Management Portal

Puede cambiar la configuración de un Runbook en el Portal de administración desde la página Configurar del Runbook.You can change settings for a runbook in the Management Portal from the Configure page for the runbook.

  1. En el Portal de administración, seleccione Automatización.In the Management Portal, select Automation.

  2. Seleccione la pestaña Runbooks .Select the Runbooks tab.

  3. Haga clic en el nombre de un Runbook.Click the name of a runbook.

  4. Seleccione la pestaña Configurar .Select the Configure tab.

Cambiar la configuración de un runbook con Windows PowerShellChanging runbook settings with Windows PowerShell

Puede usar el cmdlet Set-SmaRunbookConfiguration para cambiar toda la configuración de un Runbook, excepto las etiquetas.You can use the Set-SmaRunbookConfiguration cmdlet to change all the settings for a runbook except for Tags. Solo puede cambiar y agregar etiquetas de Runbooks existentes mediante el Portal de administración.You can only change and add Tags for existing runbooks using the Management Portal. Solo se pueden establecer etiquetas para Runbooks con PowerShell al importar un Runbook mediante Import-SmaRunbook.You can only set Tags for runbooks with PowerShell when you import a runbook using Import-SmaRunbook.

Los siguientes comandos de ejemplo muestran cómo establecer las propiedades de un Runbook.The following sample commands show how to set the properties for a runbook. En este ejemplo se agrega una descripción y se especifica la necesidad de registros detallados.This sample adds a description and specifies that verbose records should be logged.

$webServer = 'https://MyServer'
$port = 9090
$runbookName = "Sample-TestRunbook"

Set-SmaRunbookConfiguration "WebServiceEndpoint $webServer "Port $port "Name $runbookName "Description "Sample runbook" "LogVerbose $true

Pasos siguientesNext steps