Documentation

Instance Groups API Endpoint

Make a GET request to this resource to retrieve the list of instance groups.

GET /api/v2/instance_groups/
HTTP 200 OK
Allow: GET, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept
X-API-Node: localhost
X-API-Time: 0.172s

The resulting data structure contains:

{
    "count": 99,
    "next": null,
    "previous": null,
    "results": [
}

The count field indicates the total number of instance groups found for the given query. The next and previous fields provides links to additional results if there are more than will fit on a single page. The results list contains zero or more instance group records.

Results

Each instance group data structure includes the following fields:

  • id: Database ID for this instance group. (integer)
  • type: Data type for this instance group. (choice)
    • instance group: Instance Group
  • url: URL for this instance group. (string)
  • related: Data structure with URLs of related resources. (object)
    • jobs: Jobs
    • instances: Instances
  • name: Name of this instance group. (string)
  • created: Timestamp when this instance group was created. (datetime)
  • modified: Timestamp when this instance group was last modified. (datetime)
  • capacity: Total capacity for this instance group. (field)
  • consumed_capacity: Capacity this instance group has consumed. (field)
  • percent_capacity_remaining: Percentage remaining capacity for this instance group. (field)
  • jobs_running: Number of jobs running on this instance group. (field)
  • instances: Number of instances running on this instance group. (field)
  • controller: Instance Group to remotely control this group. (field)

Sorting

To specify that instance groups are returned in a particular order, use the order_by query string parameter on the GET request.

?order_by=name

Prefix the field name with a dash - to sort in reverse:

?order_by=-name

Multiple sorting fields may be specified by separating the field names with a comma ,:

?order_by=name,some_other_field

Searching

Use the search query string parameter to perform a case-insensitive search within all designated text fields of a model.

?search=findme

Search across related fields (added in AWX 1.4 / Ansible Tower 3.1):

?related__search=findme

Filtering

Any additional query string parameters may be used to filter the list of results returned to those matching a given value. Only fields and relations that exist in the database may be used for filtering. Any special characters in the specified value should be URL-encoded. For example:

?field=value%20xyz

Fields may also span relations, only for fields and relationships defined in the database:

?other__field=value

To exclude results matching certain criteria, prefix the field parameter with not__:

?not__field=value

By default, all query string filters are AND’ed together, so only the results matching all filters will be returned (added in AWX 1.4). To combine results matching any one of multiple criteria, prefix each query string parameter with or__:

?or__field=value&or__field=othervalue
?or__not__field=value&or__field=othervalue

The default AND filtering applies all filters simultaneously to each related object being filtered across database relationships (added in Ansible Tower 1.4.5). The chain filter instead applies filters separately for each related object. To use, prefix the query string parameter with chain__:

?chain__related__field=value&chain__related__field2=othervalue
?chain__not__related__field=value&chain__related__field2=othervalue

If the first query above were written as ?related__field=value&related__field2=othervalue, it would return only the primary objects where the same related object satisfied both conditions. As written using the chain filter, it would return the intersection of primary objects matching each condition.

Field lookups may also be used for more advanced queries, by appending the lookup to the field name:

?field__lookup=value

The following field lookups are supported:

  • exact: Exact match (default lookup if not specified).
  • iexact: Case-insensitive version of exact.
  • contains: Field contains value.
  • icontains: Case-insensitive version of contains.
  • startswith: Field starts with value.
  • istartswith: Case-insensitive version of startswith.
  • endswith: Field ends with value.
  • iendswith: Case-insensitive version of endswith.
  • regex: Field matches the given regular expression.
  • iregex: Case-insensitive version of regex.
  • gt: Greater than comparison.
  • gte: Greater than or equal to comparison.
  • lt: Less than comparison.
  • lte: Less than or equal to comparison.
  • isnull: Check whether the given field or related object is null; expects a boolean value.
  • in: Check whether the given field’s value is present in the list provided; expects a list of items.

Boolean values may be specified as True or 1 for true, False or 0 for false (both case-insensitive).

Null values may be specified as None or Null (both case-insensitive), though it is preferred to use the isnull lookup to explicitly check for null values.

Lists (for the in lookup) may be specified as a comma-separated list of values.

Filtering based on the requesting user’s level of access by query string parameter (added in Ansible Tower 3.1).

  • role_level: Level of role to filter on, such as admin_role

Reviewing the Options Endpoint

The Options Endpoint table offers a view of the Options for this endpoint. When viewing the endpoint in the browsable API, clicking the “Options” button gives you the raw JSON for the following:

name Instance Groups
description # List Instance Groups: Make a GET request to this resource to retrieve the list of instance groups.
renders
0 application/json
1 text/html
parses
0 application/json
added_in_version 3.2.0
actions
GET
id
type integer
label ID
help_text Database ID for this instance group.
type
type choice
label Type
help_text Data type for this instance group.
choices
0
0 instance_ group
1 Instance Group
url
type string
label URL
help_text URL for this instance group.
related
type object
label Related
help_text Data structure with URLs of related resources.
name
type string
label Name
help_text Name of this instance group.
created
type datetime
label Created
help_text Timestamp when this instance group was created.
modified
type datetime
label Modified
help_text Timestamp when this instance group was last modified.
capacity
type field
label Capacity
help_text Total capacity for this instance group.
consumed_capacity
type field
label Consumed capacity
help_text Capacity this instance group has consumed.
percent_capacity_remaining
type field
label Percent capacity remaining
help_text Percentage remaining capacity for this instance group.
jobs_running
type field
label Jobs running
help_text Number of jobs running in this instance group.
instances
type field
label Instances
help_text Number of instances running on this instance group.
controller
type field
label Controller
help_text Instance Group to remotely control this group.
types
0 instance_group
search_fields
0 name
related_search_fields
0 controller__search
1 controlled_groups__search
2 instances__search

Copyright © 2018 Red Hat, Inc.

Red Hat Ansible Tower docs are generated using Sphinx using a theme provided by Read the Docs.