GET /api/job_invocations
Listar invocaciones de trabajo

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer

search
opcional

filtrar resultados

Validations:

  • Must be a String

order
opcional

organizar resultados

Validations:

  • Must be a String

page
opcional

paginar resultados

Validations:

  • Must be a String

per_page
opcional

número de entradas por solicitud

Validations:

  • Must be a String


GET /api/job_invocations/:id
Mostrar invocación de trabajo

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer

id
requerido

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


POST /api/job_invocations
Crear una invocación de trabajo

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer

job_invocation
requerido

Validations:

  • Must be a Hash

job_invocation[job_template_id]
opcional , nil permitido

The job template to use, parameter is required unless feature was specified

Validations:

  • Must be a String

job_invocation[targeting_type]
requerido

Invocation type, one of {“static_query”=>“Static Query”, “dynamic_query”=>“Dynamic Query”}

Validations:

  • Must be a String

job_invocation[inputs]
opcional , nil permitido

Entradas que se deben utilizar

Validations:

  • Must be a Hash

job_invocation[ssh]
opcional , nil permitido

Opciones específicas del proveedor SSH

Validations:

  • Must be a Hash

job_invocation[ssh][effective_user]
opcional , nil permitido

El usuario que se debe utilizar para ejecutar el script (con mecanismos tipo sudo). El valor predeterminado es un parámetro de plantilla o una configuración global.

Validations:

  • Must be a String

job_invocation[recurrence]
opcional , nil permitido

Crear un trabajo recurrente

Validations:

  • Must be a Hash

job_invocation[recurrence][cron_line]
opcional , nil permitido

Con qué frecuencia debe ocurrir el trabajo, en formato programado

Validations:

  • Must be a String

job_invocation[recurrence][max_iteration]
opcional , nil permitido

Repetir un máximo de N veces

Validations:

  • Must be a number.

job_invocation[recurrence][end_time]
opcional , nil permitido

No ejecutar más después de esta cantidad de veces

Validations:

  • Must be a DateTime

job_invocation[scheduling]
opcional , nil permitido

Programar el trabajo para que comience más tarde

Validations:

  • Must be a Hash

job_invocation[scheduling][start_at]
opcional , nil permitido

Programar el trabajo para el futuro

Validations:

  • Must be a DateTime

job_invocation[scheduling][start_before]
opcional , nil permitido

Indica que la acción se debe cancelar si no se puede iniciar antes de este momento.

Validations:

  • Must be a DateTime

job_invocation[concurrency_control]
opcional , nil permitido

Controlar el nivel de concurrencia y la distribución en el tiempo

Validations:

  • Must be a Hash

job_invocation[concurrency_control][time_span]
opcional , nil permitido

Distribuir tareas en N segundos

Validations:

  • Must be a Integer

job_invocation[concurrency_control][concurrency_level]
opcional , nil permitido

Ejecutar un máximo de N tareas por vez

Validations:

  • Must be a Integer

job_invocation[bookmark_id]
opcional , nil permitido

Validations:

  • Must be a Integer

job_invocation[search_query]
opcional , nil permitido

Validations:

  • Must be a String

job_invocation[description_format]
opcional , nil permitido

Sustituir el formato de descripción de la plantilla solo para esta invocación

Validations:

  • Must be a String

job_invocation[execution_timeout_interval]
opcional , nil permitido

Override the timeout interval from the template for this invocation only

Validations:

  • Must be a Integer

job_invocation[feature]
opcional , nil permitido

Remote execution feature label that should be triggered, job template assigned to this feature will be used

Validations:

  • Must be a String


GET /api/job_invocations/:id/hosts/:host_id
Obtener salida para un host

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer

id
requerido

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

host_id
requerido

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

since
opcional

Validations:

  • Must be a String


POST /api/job_invocations/:id/cancel
Cancel job invocation

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer

id
requerido

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

force
opcional

Validations:

  • Must be one of: true, false, 1, 0


POST /api/job_invocations/:id/rerun
Rerun job on failed hosts

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer

id
requerido

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

failed_only
opcional

Validations:

  • Must be one of: true, false, 1, 0