1. Oracle Linux Automation Manager CLI and API Reference Guide
  2. Tasks
  3. Host Metrics

List Host Metrics

get

/api/v2/host_metrics/

Make a GET request to this resource to retrieve the list of host metrics.

The resulting data structure contains:

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

The count field indicates the total number of host metrics 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 host metric records.

Results

Each host metric data structure includes the following fields:

  • id: Database ID for this host metric. (integer)
  • hostname: (string)
  • url: URL for this host metric. (string)
  • first_automation: When the host was first automated against (datetime)
  • last_automation: When the host was last automated against (datetime)
  • last_deleted: When the host was last deleted (datetime)
  • automated_counter: How many times was the host automated (integer)
  • deleted_counter: How many times was the host deleted (integer)
  • deleted: Boolean flag saying whether the host is deleted and therefore not counted into the subscription consumption (boolean)
  • used_in_inventories: How many inventories contain this host (integer)

Sorting

To specify that host metrics 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 : HostMetric
Type: object
Show Source
Back to Top