This method will run a playbook in Ansible Manager
Route
No Northbound API Available
Roles
admin
Parameters
DetailsExampleSchema
Name
Type
Required
Description
playbookId
string
yes
the id of the playbook to run
hosts
array
yes
an array of hosts to run the playbook on
params
object
yes
an object containing the parameters to pass into the playbook
Copied to Clipboard
{
"playbookId": "laboris in eiusmod ipsum est",
"hosts": [],
"params": null
}
Copied to Clipboard
{
"type": "object",
"properties": {
"playbookId": {
"description": "the id of the playbook to run",
"type": "string"
},
"hosts": {
"description": "an array of hosts to run the playbook on",
"type": "array"
},
"params": {
"description": "an object containing the parameters to pass into the playbook",
"type": "object",
"properties": {},
"required": [
"params"
],
"additionalProperties": false
}
},
"required": [
"playbookId",
"hosts",
"params"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name
Type
Description
result
object
the status of running the playbook on each host
Copied to Clipboard
{
"result": true
}
Copied to Clipboard
{
"description": "the status of running the playbook on each host",
"type": "object",
"properties": {
"result": true
},
"required": [
"result"
],
"additionalProperties": false
}
