To get the compliance status for each node along with its IP address and hostname, I'm able to use the "Download Report" option in the UI, but I cannot distinguish the nodes between one node manager and another since all of them are included within the same report based on the date/timestamp.

Using the API, I'm trying to identify how to retrieve the compliance status information per node manager or per scan job along with the relevant node IP address and hostname information. I need an efficient method to get a report of the compliance status information of each node within a specific AWS node manager (not all nodes) that the scan was run on along with the complete node information, including the IP addresses, hostnames and tags pulled from the AWS node manager.

NA

NA

You can use the Chef Automate API for listing and filtering nodes for this purpose. The key while using this API is to pass the node manager ID as a header in the API request.

This API supports filtering, pagination, and sorting. Adding a filter narrows the list of nodes to only those that match the filter or filters. 

The Chef Automate API typically uses an API token passed in the header of your API request.

To create admin token and set it as an environment variable use the following command:

export TOKEN=`chef-automate iam token create <TOKEN-NAME> --admin`

An admin token has unlimited access to the entire Chef Automate API.

Please refer to the below document for the details of the API request.

https://docs.chef.io/automate/api/#tag/NodesService/operation/NodesService_List

Sample request:

curl --location 'https://MY_AUTOMATE_FQDN/api/v0/nodes/search'; \ --header 'api-token: $TOKEN' \ --data '{ "filters": [ { "key": "manager_id", "values": [ "<AWS-NODE-MANAGER-ID>" ] } ], "page": 1, "per_page": 100 }'

The 'page' and 'per_page' values in the request header determine how many node details will be returned by Chef Automate API per page of response and should be modified according to your requirement. 

A successful response should look like following with a 200 response code. It will contain an array with all details and compliance statuses of each node belonging to that specific node manager.

{ "nodes": [ { "id": "<Node-ID>", "name": "<NODE-IP-ADDRESS>", "platform": "ubuntu", "platform_version": "20.04", "manager": "automate", "tags": [ { "key": "environment", "value": "unknown" } ], "last_contact": "2023-06-01T09:04:05Z", "status": "reachable", "last_job": { "node_id": "<NODE-ID>", "report_id": "", "status": "completed", "result": "", "job_id": "90bcf940-b41e-4699-9ef4-b550d0084f6a", "start_time": null, "end_time": null }, "target_config": null, "manager_ids": [ "<NODE-MANAGER-ID>" ], "connection_error": "", "state": "RUNNING", "name_prefix": "", "projects": [], "run_data": { "id": "", "status": "UNKNOWN", "penultimate_status": "UNKNOWN", "end_time": null }, "scan_data": { "id": "1977335d-fb93-4421-87e0-5ff2db99044d", "status": "FAILED", "penultimate_status": "UNKNOWN", "end_time": "2023-06-01T09:04:04Z" } }, ], "total": 2, "total_unreachable": 210, "total_reachable": 3, "total_unknown": 30 }

To explore various Chef Automate APIs, go to: https://docs.chef.io/automate/api/