GET /api/job_invocations
Job-Aufrufe auflisten

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

search
optional

Ergebnisse filtern

Validations:

  • Must be a String

order
optional

Ergebnisse sortieren

Validations:

  • Must be a String

page
optional

Ergebnisse nummerieren

Validations:

  • Must be a String

per_page
optional

Anzahl der Einträge pro Anfrage

Validations:

  • Must be a String


GET /api/job_invocations/:id
Job-Aufrufe anzeigen

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

id
verpflichtend

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
Neuen Job-Aufruf erstellen

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

job_invocation
verpflichtend

Validations:

  • Must be a Hash

job_invocation[job_template_id]
optional , nil erlaubt

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

Validations:

  • Must be a String

job_invocation[targeting_type]
verpflichtend

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

Validations:

  • Must be a String

job_invocation[inputs]
optional , nil erlaubt

Zu verwendende Eingaben

Validations:

  • Must be a Hash

job_invocation[ssh]
optional , nil erlaubt

Besondere Optionen des SSH-Anbieters

Validations:

  • Must be a Hash

job_invocation[ssh][effective_user]
optional , nil erlaubt

Welcher Benutzer zur Ausführung des Skripts (mittels sudo-ähnlichen Mechanismen) verwendet werden soll. Standardmäßig wird ein Vorlagenparameter oder eine allgemeine Einstellung verwendet.

Validations:

  • Must be a String

job_invocation[recurrence]
optional , nil erlaubt

Wiederholten Job erstellen

Validations:

  • Must be a Hash

job_invocation[recurrence][cron_line]
optional , nil erlaubt

Wie oft der Job auftreten soll, in Cron-Format

Validations:

  • Must be a String

job_invocation[recurrence][max_iteration]
optional , nil erlaubt

Maximal n-mal wiederholen

Validations:

  • Must be a number.

job_invocation[recurrence][end_time]
optional , nil erlaubt

Danach nicht mehr ausführen

Validations:

  • Must be a DateTime

job_invocation[scheduling]
optional , nil erlaubt

Job zu einer späteren Zeit starten lassen

Validations:

  • Must be a Hash

job_invocation[scheduling][start_at]
optional , nil erlaubt

Job zu einem zukünftigen Zeitpunkt starten lassen

Validations:

  • Must be a DateTime

job_invocation[scheduling][start_before]
optional , nil erlaubt

Gibt an, dass die Aktion abgebrochen werden soll, wenn sie nicht vor diesem Zeitpunkt gestartet werden kann.

Validations:

  • Must be a DateTime

job_invocation[concurrency_control]
optional , nil erlaubt

Parallelitätsebene und zeitliche Verteilung steuern

Validations:

  • Must be a Hash

job_invocation[concurrency_control][time_span]
optional , nil erlaubt

Aufgaben über n Sekunden verteilen

Validations:

  • Must be a Integer

job_invocation[concurrency_control][concurrency_level]
optional , nil erlaubt

Höchstens n Aufgaben gleichzeitig ausführen

Validations:

  • Must be a Integer

job_invocation[bookmark_id]
optional , nil erlaubt

Validations:

  • Must be a Integer

job_invocation[search_query]
optional , nil erlaubt

Validations:

  • Must be a String

job_invocation[description_format]
optional , nil erlaubt

Beschreibungsformat der Vorlage nur für diesen Aufruf außer Kraft setzen

Validations:

  • Must be a String

job_invocation[execution_timeout_interval]
optional , nil erlaubt

Override the timeout interval from the template for this invocation only

Validations:

  • Must be a Integer

job_invocation[feature]
optional , nil erlaubt

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
Ausgabe für einen Host abfragen

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

id
verpflichtend

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
verpflichtend

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
optional

Validations:

  • Must be a String


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

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

id
verpflichtend

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
optional

Validations:

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


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

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

id
verpflichtend

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
optional

Validations:

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