awx.awx.controller_api lookup – Search the API for objects

Note

This lookup plugin is part of the awx.awx collection (version 21.8.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install awx.awx. You need further requirements to be able to use this lookup plugin, see Requirements for details.

To use it in a playbook, specify: awx.awx.controller_api.

Synopsis

Requirements

The below requirements are needed on the local controller node that executes this lookup.

  • None

Terms

Parameter

Comments

Terms

string / required

The endpoint to query, i.e. teams, users, tokens, job_templates, etc.

Parameters

Parameter

Comments

expect_objects

aliases: expect_object

boolean

Error if the response does not contain either a detail view or a list view.

Choices:

  • false ← (default)

  • true

expect_one

boolean

Error if the response contains more than one object.

Choices:

  • false ← (default)

  • true

host

string

The network address of your Automation Platform Controller host.

Configuration:

  • Environment variable: CONTROLLER_HOST

  • Environment variable: TOWER_HOST

    Removed in: version 4.0.0

    Why: Collection name change

    Alternative: CONTROLLER_HOST

max_objects

integer

if return_all is true, this is the maximum of number of objects to return from the list.

If a list view returns more an max_objects an exception will be raised

Default: 1000

oauth_token

string

The OAuth token to use.

Configuration:

  • Environment variable: CONTROLLER_OAUTH_TOKEN

  • Environment variable: TOWER_OAUTH_TOKEN

    Removed in: version 4.0.0

    Why: Collection name change

    Alternative: CONTROLLER_OAUTH_TOKEN

password

string

The password for your controller user.

Configuration:

  • Environment variable: CONTROLLER_PASSWORD

  • Environment variable: TOWER_PASSWORD

    Removed in: version 4.0.0

    Why: Collection name change

    Alternative: CONTROLLER_PASSWORD

query_params

aliases: query, data, filter, params

dictionary

The query parameters to search for in the form of key/value pairs.

return_all

boolean

If the response is paginated, return all pages.

Choices:

  • false ← (default)

  • true

return_ids

aliases: return_id

boolean

If response contains objects, promote the id key to the top-level entries in the list.

Allows looking up a related object and passing it as a parameter to another module.

This will convert the return to a string or list of strings depending on the number of selected items.

Choices:

  • false ← (default)

  • true

return_objects

boolean

If a list view is returned, promote the list of results to the top-level of list returned.

Allows using this lookup plugin to loop over objects without additional work.

Choices:

  • false

  • true ← (default)

username

string

The user that you plan to use to access inventories on the controller.

Configuration:

  • Environment variable: CONTROLLER_USERNAME

  • Environment variable: TOWER_USERNAME

    Removed in: version 4.0.0

    Why: Collection name change

    Alternative: CONTROLLER_USERNAME

verify_ssl

aliases: validate_certs

boolean

Specify whether Ansible should verify the SSL certificate of the controller host.

Defaults to True, but this is handled by the shared module_utils code

Choices:

  • false

  • true

Configuration:

  • Environment variable: CONTROLLER_VERIFY_SSL

  • Environment variable: TOWER_VERIFY_SSL

    Removed in: version 4.0.0

    Why: Collection name change

    Alternative: CONTROLLER_VERIFY_SSL

Notes

Note

  • If the query is not filtered properly this can cause a performance impact.

  • If no config_file is provided we will attempt to use the tower-cli library defaults to find your host information.

  • config_file should be in the following format host=hostname username=username password=password

Examples

- name: Load the UI settings
  set_fact:
    controller_settings: "{{ lookup('awx.awx.controller_api', 'settings/ui') }}"

- name: Load the UI settings specifying the connection info
  set_fact:
    controller_settings: "{{ lookup('awx.awx.controller_api', 'settings/ui' host='controller.example.com',
                             username='admin', password=my_pass_var, verify_ssl=False) }}"

- name: Report the usernames of all users with admin privs
  debug:
    msg: "Admin users: {{ query('awx.awx.controller_api', 'users', query_params={ 'is_superuser': true }) | map(attribute='username') | join(', ') }}"

- name: debug all organizations in a loop  # use query to return a list
  debug:
    msg: "Organization description={{ item['description'] }} id={{ item['id'] }}"
  loop: "{{ query('awx.awx.controller_api', 'organizations') }}"
  loop_control:
    label: "{{ item['name'] }}"

- name: Make sure user 'john' is an org admin of the default org if the user exists
  role:
    organization: Default
    role: admin
    user: john
  when: "lookup('awx.awx.controller_api', 'users', query_params={ 'username': 'john' }) | length == 1"

- name: Create an inventory group with all 'foo' hosts
  group:
    name: "Foo Group"
    inventory: "Demo Inventory"
    hosts: >-
      {{ query(
           'awx.awx.controller_api',
            'hosts',
            query_params={ 'name__startswith' : 'foo', },
        ) | map(attribute='name') | list }}
  register: group_creation

Return Value

Key

Description

Return value

dictionary

Response from the API

Returned: on successful request

Authors

  • John Westcott IV (@john-westcott-iv)

Hint

Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.