Use actions and flowsActionsActions reference

automation-start-manual

Purpose

This automation starts an automation given the name of the automation and the trigger, as well as optional form data if desired.

This action makes multiple calls into Itential to get the correct information to start the automation. This includes getting the proper automation and trigger in order to determine the data required to start the automation.

automation-start-manual

APIs used:

/operations-manager/automations
/operations-manager/triggers
/operations-manager/triggers/manual/:id/run

Input

InputsData TypeSample InputDescription
instance_nameDropdown (String)SE Lab Prod 2023.1The Itential Platform instance name
automation_nameStringtest_snow_actionsName of the automation
trigger_nameStringtest_form_triggerName of the manual trigger
form_data (optional)JSON{ "formData":{ "OS-Type":"cisco-ios", "severity":"HIGH" } }Form data as per the schema being used by the trigger. Note: Refer the sample input to structure the JSON object in the same format.
token (optional)string9f0999c2-7054-4820-8eeb-c3052d30acaaAuthentication token or empty if an API key is used

Output

OutputData TypeSample OutputDescription
automation_responseJSONSample output as mentioned belowReturns a JSON object with the start status of the automation
job_idString4278c701b83943b08a98***The Job ID of the automation that was started

Sample 1 - Output

1{
2    "taskId": "workflow_start",
3    "owner": "Pronghorn",
4    "iterations": [],
5    "transitions": {
6        "success": [
7            {
8                "task": "6e4c",
9                "type": "standard"
10            },
11            {
12                "task": "30e5",
13                "type": "standard"
14            }
15        ]
16    }
17}

Sample 2 - Output

1{
2    "taskId": "workflow_end",
3    "owner": "Pronghorn",
4    "iterations": [],
5    "transitions": {},
6    "endTasks": {
7        "incomplete": [
8            "30e5"
9        ],
10        "complete": [],
11        "error": []
12    }
13}

Sample 3 - Output

1{
2    "taskId": "ec30",
3    "owner": "Pronghorn",
4    "iterations": [],
5    "transitions": {
6        "success": [
7            {
8                "task": "workflow_end",
9                "type": "standard"
10            }
11        ]
12    }
13}

Sample 4 - Output

1{
2    "taskId": "6e4c",
3    "owner": "Pronghorn",
4    "iterations": [],
5    "transitions": {
6        "success": [
7            {
8                "task": "ec30",
9                "type": "standard"
10            }
11        ]
12    }
13}

Sample 5 - Output

1{
2    "taskId": "30e5",
3    "owner": "Pronghorn",
4    "iterations": [],
5    "transitions": {},
6    "status": "running",
7    "variables": {
8        "time": "10",
9        "endtime": "20",
10        "_id": "8d887c9ad8a54569b3a44849",
11        "initiator": "snow-token"
12    },
13    "metrics": {
14        "start_time": 1690904550118,
15        "user": "63fc02eed99e7739b84b660e",
16        "progress": 0
17    }
18}

Error Output

Error OutputData TypeSample OutputDescription
error_messageStringMethod failed: (/operations-manager/automations) with code: 401 - Invalid username/password combinationError message