Ansible_roles

>>>

GET /ansible/api/ansible_roles/:id
Show role

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
>>>

GET /ansible/api/ansible_roles
List Ansible roles

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
search
optional

filter results

Validations:

  • String
order
optional

Sort and order by a searchable field, e.g. '<field> DESC'

Validations:

  • String
page
optional

Page number, starting at 1

Validations:

  • Must be a number.
per_page
optional

Number of results per page to return, 'all' to return all results

Validations:

  • Must match regular expression /\A([1-9]\d*|all)\Z$/.

Search fields

Field name Type Possible values
host string
host_id integer
hostgroup string
hostgroup_id integer
id integer
name string
updated_at datetime
>>>

DELETE /ansible/api/ansible_roles/:id
Deletes Ansible role

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
>>>

PUT /ansible/api/ansible_roles/import DEPRECATED
DEPRECATED: Import Ansible roles

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
proxy_id
required

Smart Proxy to import from

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
role_names
optional

Ansible role names to be imported

Validations:

  • Must be an array of any type
>>>

PUT /ansible/api/ansible_roles/sync
Sync Ansible roles

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
proxy_id
required

Smart Proxy to sync from

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
role_names
optional

Ansible role names to be synced

Validations:

  • Must be an array of any type
>>>

PUT /ansible/api/ansible_roles/obsolete DEPRECATED
DEPRECATED: Obsolete Ansible roles

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
proxy_id
optional

Smart Proxy to import from

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
>>>

GET /ansible/api/ansible_roles/fetch
Fetch Ansible roles available to be synced

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
proxy_id
required

Smart Proxy to fetch from

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..