Oracle Linux Automation Manager CLI and API Reference Guide

Launch a Job Template

get

/api/v2/system_job_templates/{id}/launch/

Make a POST request to this resource to launch the system job template.

Variables specified inside of the parameter extra_vars are passed to the system job task as command line parameters. These tasks can be run manually on the host system via the awx-manage command.

For example on cleanup_jobs and cleanup_activitystream:

{"extra_vars": {"days": 30}}

Which will act on data older than 30 days.

For cleanup_activitystream and cleanup_jobs commands, providing "dry_run": true inside of extra_vars will show items that will be removed without deleting them.

Each individual system job task has its own default values, which are applicable either when running it from the command line or launching its system job template with empty extra_vars.

Defaults for cleanup_activitystream: days=90
Defaults for cleanup_jobs: days=90

If successful, the response status code will be 202. If the job cannot be launched, a 405 status code will be returned.

Request

Supported Media Types

application/json

Path Parameters

id(required): string

Query Parameters

page: integer

A page number within the paginated result set.
page_size: integer

Number of results to return per page.
search: string

A search term.

Response

Supported Media Types

application/json

200 Response

Root Schema : schema

Type: object

Show Source

count(required): integer
next: string(uri)
previous: string(uri)
results(required): array results

{
    "properties":{
        "count":{
            "type":"integer"
        },
        "next":{
            "format":"uri",
            "type":"string",
            "x-nullable":true
        },
        "previous":{
            "format":"uri",
            "type":"string",
            "x-nullable":true
        },
        "results":{
            "items":{
                "$ref":"#/definitions/Empty"
            },
            "type":"array"
        }
    },
    "required":[
        "count",
        "results"
    ],
    "type":"object"
}

Nested Schema : results

Type: array

Show Source

Array of: object Empty

{
    "items":{
        "$ref":"#/definitions/Empty"
    },
    "type":"array"
}

Nested Schema : Empty

Type: object

Show Source

{
    "properties":{
    },
    "type":"object"
}