1. Oracle Linux Automation Manager CLI and API Reference Guide
  2. Tasks
  3. Instance Groups

List Instance Groups

get

/api/v2/instance_groups/

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

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)
  • url: URL for this instance group. (string)
  • related: Data structure with URLs of related resources. (object)
  • 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: (field)
  • consumed_capacity: (field)
  • percent_capacity_remaining: (field)
  • jobs_running: (field)
  • max_concurrent_jobs: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)
  • max_forks: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)
  • jobs_total: Count of all jobs that target this instance group (integer)
  • instances: (field)
  • is_container_group: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)
  • credential: (id)
  • policy_instance_percentage: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)
  • policy_instance_minimum: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)
  • policy_instance_list: List of exact-match Instances that will be assigned to this group (json)
  • pod_spec_override: (string)
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)

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

Pagination

Use the page_size query string parameter to change the number of results returned for each request. Use the page query string parameter to retrieve a particular page of results.

?page_size=100&page=2

The previous and next links returned with the results will set these query string parameters automatically.

Searching

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

?search=findme

(Added in Ansible Tower 3.1.0) Search across related fields:

?related__search=findme

Request

Supported Media Types
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : results
Type: array
Show Source
Nested Schema : InstanceGroup
Type: object
Show Source
Nested Schema : policy_instance_list
Type: array
List of exact-match Instances that will be assigned to this group
Show Source
Back to Top