|
Description |
Creates a task sequence |
|||||||||||
|
Request URL |
POST /neo/app/tasks |
|||||||||||
|
Status Codes |
Note: status code 403 FORBIDDEN means that a task sequence is being added to a task sequence |
|||||||||||
Request Data:
{
" task_list " : [{
"taskID" : "c75a8b4a - 2722 - 43b1 - 9eb8 - 768c7459d651",
"taskDelay" : 0
"taskState" : 1
}, {
"taskID" : "923dae76 - c2a8 - 43d9 - a1f6 - 5cc4aad3a449",
"taskDelay" : 0
"taskState" : 1
}
],
"schedule" : {
"active" : true,
"timezone" : "Asia/Jerusalem",
"trigger" : "date",
"date" : "2016-9-18 09:15:00"
}
"task_execution " : "serial",
"task_type" : "TaskGroup",
"group_description" : "group"
}
taskDelay value can only be 0
task_execution value can only be "serial"
schedule is optional
taskState value can only be "run" = 1
|
Description |
Updates a task sequence |
|||||||||||
|
Request URL |
PUT /neo/app/tasks/<task_id> |
|||||||||||
|
Status Codes |
Note: status code 403 FORBIDDEN means that a task sequence is being added to a task sequence |
|||||||||||
Request Data:
{
"task_list" : [{
"taskID" : "c75a8b4a - 2722 - 43b1 - 9eb8 - 768c7459d651",
"taskDelay" : 0
}, {
"taskID" : "923dae76 - c2a8 - 43d9 - a1f6 - 5cc4aad3a449",
"taskDelay" : 0
"taskState" : "skip"
}
],
"schedule" : {
"active" : true,
"timezone" : "Asia/Jerusalem",
"trigger" : "date",
"date" : "2016-9-18 09:15:00"
}
"task_execution" : "serial"
"task_type" : "TaskGroup"
"group_description" : "Group"
}
taskDelay value can only be 0
task_execution value can only be "serial"
|
Description |
This API is to execute a task sequence. |
|||||||||||
|
Request URL |
POST /neo/app/tasks/<task_id>/run |
|||||||||||
|
Request Data |
{} |
|||||||||||
|
Description |
Delete a task sequence |
|||||||||||
|
Request URL |
DELETE /neo/app/tasks/<task_id> |
|||||||||||
|
Request Data |
N/A |
|||||||||||
In case a task is part of a task sequence, this task cannot be deleted. Task groups can always be deleted.
|
Description |
Retrieves the task sequence information |
|||||||||||
|
Request URL |
GET /neo/app/tasks/task_group |
|||||||||||
|
Request Data |
N/A |
|||||||||||
Response:
[
{
"group_id": "93d6e110-98ae-45f0-bb45-fb9cd9531f8f",
"group_list": [
{
"group_instance_id": "59333438-0868-4fbf-8605-40fbcccb621c",
"status": "Completed",
"lastRunTime": "2016-10-27 08:33:18"
"task_list": [
{
"job_status": "Completed",
"job_id": "8",
"task_id": "81a6886d-b6a2-4840-8b8e-696d2b4af5f8"
},
{
"job_status": "Completed",
"job_id": "6",
"task_id": "c8866591-af33-4e7d-aa8a-b1872c5dfecf",
}
]
},
{
"group_instance_id": "f8bc1f71-6b71-4d16-a55c-15ee5bdcd040",
"status": "Completed",
"lastRunTime": "2016-10-27 08:33:50"
"task_list": [
{
"job_status": "Completed",
"job_id": "12",
"task_id": "81a6886d-b6a2-4840-8b8e-696d2b4af5f8",
},
{
"job_status": "Completed",
"job_id": "10",
"task_id": "c8866591-af33-4e7d-aa8a-b1872c5dfecf",
}
]
}
]
}
]
|
Description |
Retrieves a specific task sequence information |
|||||||||||
|
Request URL |
GET /nep/app/tasks/task_group/ ?group_ids=\["93d6e110-98ae-45f0-bb45-fb9cd9531f8f"\] |
|||||||||||
|
Request Data |
N/A |
|||||||||||
Response:
[
{
"group_id": "93d6e110-98ae-45f0-bb45-fb9cd9531f8f",
"group_list": [
{
"group_instance_id": "59333438-0868-4fbf-8605-40fbcccb621c",
"status": "Completed",
"lastRunTime": "2016-10-27 08:33:18"
"task_list": [
{
"job_status": "Completed",
"job_id": "8",
"task_id": "81a6886d-b6a2-4840-8b8e-696d2b4af5f8"
},
{
"job_status": "Completed",
"job_id": "6",
"task_id": "c8866591-af33-4e7d-aa8a-b1872c5dfecf",
}
]
},
]
}
]
|
Description |
Retrieves all tasks information |
|||||||||||
|
Request URL |
GET /nep/app/tasks |
|||||||||||
|
Request Data |
N/A |
|||||||||||
Response:
[
{
"lastJobId": "",
"description": "b",
"schedule": {},
"instanceID": "75a414ce-cf51-4936-aaf8-c6215c9499ca",
"createdOn": "2016-10-18 10:45:43",
"object_type": "System",
"object_ids": [
"10.209.37.30"
],
"parent_task_id": null,
"action": "Provisioning",
"readOnly": false,
"task_type": "",
"params": {
"commandline": [
"show snmp",
""
],
"arguments": {
"globals": {},
"devices": {
"10.209.37.30": {}
}
}
},
"lastRunTime": "2016-10-19 06:56:43",
"owner": "admin",
"hidden": false
},
{
"lastJobId": "",
"description": "a",
"schedule": {},
"instanceID": "3db929be-7b7e-4270-9886-173ecd5a227e",
"createdOn": "2016-10-18 10:45:24",
"object_type": "System",
"object_ids": [
"10.209.37.13"
],
"parent_task_id": null,
"action": "Provisioning",
"readOnly": false,
"task_type": "",
"params": {
"commandline": [
"show snmp",
""
],
"arguments": {
"globals": {},
"devices": {
"10.209.37.13": {}
}
}
},
"lastRunTime": "2016-10-19 06:56:51",
"owner": "admin",
"hidden": false
},
{
"instanceID": "746abb46-dced-471b-92e7-5b8ea0289cc4",
"readOnly": false,
"lastJobId": "",
"lastRunTime": null,
"owner": "admin",
"task_type": "TaskGroup",
"createdOn": "2016-10-18 10:47:03",
"parent_task_id": null,
"group_description" : "group",
"taskList": [
{
"taskDelay": 0,
"taskState": 1,
"taskID": "75a414ce-cf51-4936-aaf8-c6215c9499ca"
"taskDescription": "show snmp"
},
{
"taskDelay": 0,
"taskState": 1,
"taskID": "3db929be-7b7e-4270-9886-173ecd5a227e"
"taskDescription": "show snmp"
}
]
}
]
|
Description |
Retrieve all tasks information for a specific type |
|||||||||||
|
Request URL |
GET /nep/app/tasks/?task_type=type Note: Task filter can either be /?task_type=TaskGroup, or /?task_type= |
|||||||||||
|
Request Data |
N/A |
|||||||||||
Response:
task_type=TaskGroup
[ {
"instanceID":"746abb46-dced-471b-92e7-5b8ea0289cc4","readOnly":false,"lastJobId":"","lastRunTime":null,"owner":"admin","task_type":"TaskGroup","createdOn":"2016-10-18 10:47:03","parent_task_id":null,"group_description":"group","taskList": [ {"taskDelay":0,"taskState":1,"taskID":"75a414ce-cf51-4936-aaf8-c6215c9499ca"," ""v""taskDescription":"show snmp"}, {"taskDelay":0,"taskState":1,"taskID":"3db929be-7b7e-4270-9886-173ecd5a227e""taskDescription":"show snmp", } ] } ]task_type=
[ {
"lastJobId":"","description":"b","schedule": {},"instanceID":"75a414ce-cf51-4936-aaf8-c6215c9499ca","createdOn":"2016-10-18 10:45:43","object_type":"System","object_ids": ["10.209.37.30"],"parent_task_id":null,"action":"Provisioning","readOnly":false,"task_type":"","params": {"commandline": ["show snmp",""],"arguments": {"globals": {},"devices": {"10.209.37.30": {} } } },"lastRunTime":"2016-10-19 06:56:43","owner":"admin","hidden":false}, {"lastJobId":"","description":"a","schedule": {},"instanceID":"3db929be-7b7e-4270-9886-173ecd5a227e","createdOn":"2016-10-18 10:45:24","object_type":"System","object_ids": ["10.209.37.13"],"parent_task_id":null,"action":"Provisioning","readOnly":false,"task_type":"","params": {"commandline": ["show snmp",""],"arguments": {"globals": {},"devices": {"10.209.37.13": {} } } },"lastRunTime":"2016-10-19 06:56:51","owner":"admin","hidden":false}