Ansible inventories

>>>

POST /ansible/api/ansible_inventories/hosts
Show Ansible inventory for hosts

GET /ansible/api/ansible_inventories/hosts
Show Ansible inventory for hosts

Params

Param Name Description
location_id
Optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
Optional

Set the current organization context for the request

Validations:

  • Must be a Integer
host_ids
Required

IDs of hosts included in inventory

Validations:

  • Must be an array of any type
>>>

POST /ansible/api/ansible_inventories/hostgroups
Show Ansible inventory for hostgroups

GET /ansible/api/ansible_inventories/hostgroups
Show Ansible inventory for hostgroups

Params

Param Name Description
location_id
Optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
Optional

Set the current organization context for the request

Validations:

  • Must be a Integer
hostgroup_ids
Required

IDs of hostgroups included in inventory

Validations:

  • Must be an array of any type
>>>

POST /ansible/api/ansible_inventories/schedule
Schedule generating of Ansible Inventory report

Examples

POST /ansible/api/ansible_inventories/schedule
{
  "input_values": {
    "Organization": "yes",
    "Location": "yes",
    "IPv4": "yes",
    "Facts": "no"
  }
}
200
{
  "job_id": UNIQUE-REPORT-GENERATING-JOB-UUID
  "data_url": "/api/v2/report_templates/1/report_data/UNIQUE-REPORT-GENERATING-JOB-UUID"
}

Params

Param Name Description
location_id
Optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
Optional

Set the current organization context for the request

Validations:

  • Must be a Integer
input_values
Optional

Hash of input values of type input=>value

Validations:

  • Must be a Hash
report_format
Optional

Report format, defaults to 'json'

Validations:

  • Must be one of: csv, json, yaml, html.