Automox collector

[ 1 Overview ] [ 2 Minimum configuration required for basic pulling ] [ 3 Devo collector features ] [ 4 Data sources ] [ 5 Vendor setup ] [ 6 Accepted authentication methods ] [ 7 Run the collector ] [ 8 Collector services detail ] [ 9 Collector operations ] [ 10 Change log for v1.x.x ]

Overview

Automox cross-platform solution which simplifies and automates critical patching, software updates, security configurations, and custom scripting across a diversity of endpoints. It helps them easily act in real-time to drive greater strategic value and security outcomes for their business.

Minimum configuration required for basic pulling

Although this collector supports advanced configuration, the fields required to retrieve data with basic configuration are defined below.

This minimum configuration refers exclusively to those specific parameters of this integration. There are more required parameters related to the generic behavior of the collector. Check setting sections for details.

Setting	Details

Setting	Details
`api_key`	Credential api_key
`organization_id`	Credential organization_id

See the Accepted authentication methods section to verify what settings are required based on the desired authentication method.

Devo collector features

Feature	Details

Feature	Details
Allow parallel downloading (`multipod`)	`Not allowed`
Running environments	`Collector server` `On-premise`
Populated Devo events	`Table`
Flattening preprocessing	`No`

Data sources

Data source	Description	API endpoint	Collector service name	Devo table	Available from release

Data source	Description	API endpoint	Collector service name	Devo table	Available from release
Software package by device id	This service ingests all the packets of a certain device identified by an id.	`/packages`	`software_packages_by_device_id`	`itops.automox.api.package`	`v1.0.0`
All packages for all devices	This service ingests all packets from all registered devices.	`/packages`	`all_packages_for_all_devices`	`itops.automox.api.package`	`v1.0.0`

For more information on how the events are parsed, visit our page.

Vendor setup

There are some requirements to run this collector. You will need to:

Create api_key from Automox portal.
Get Autonomox organization_id.

Follow these steps:

Accepted authentication methods

Authentication Method	Username	Password
`api_key`	Required	Required

Run the collector

Once the data source is configured, you can either send us the required information if you want us to host and manage the collector for you (Cloud collector), or deploy and host the collector in your own machine using a Docker image (On-premise collector).

Collector services detail

This section is intended to explain how to proceed with specific actions for services.

All packages for all devices

Once the collector has been launched, it is important to check if the ingestion is performed in a proper way. To do so, go to the collector’s logs console.

This service has the following components:

Component	Description

Component	Description
Setup	The setup module is in charge of authenticating the service and managing the token expiration when needed.
Puller	The setup module is in charge of pulling the data in a organized way and delivering the events via SDK.

Setup output

A successful run has the following output messages for the setup module:

2023-01-23T11:24:19.182	INFO InputProcess::MainThread -> InputThread(automox_data_puller,12345) - Starting thread (execution_period=60s)
2023-01-23T11:24:19.182	INFO InputProcess::MainThread -> ServiceThread(automox_data_puller,12345,all_packages_for_all_devices,predefined) - Starting thread (execution_period=60s)
2023-01-23T11:24:19.183	INFO InputProcess::MainThread -> AutomoxDataPullerSetup(automox_collector,automox_data_puller#12345,all_packages_for_all_devices#predefined) -> Starting thread
2023-01-23T11:24:19.183	INFO InputProcess::MainThread -> AutomoxAllPackagesForAllDevicesDataPuller(automox_data_puller,12345,all_packages_for_all_devices,predefined) - Starting thread
2023-01-23T11:24:19.183 WARNING InputProcess::AutomoxAllPackagesForAllDevicesDataPuller(automox_data_puller,12345,all_packages_for_all_devices,predefined) -> Waiting until setup will be executed
2023-01-23T11:24:19.184	INFO InputProcess::AutomoxDataPullerSetup(automox_collector,automox_data_puller#12345,all_packages_for_all_devices#predefined) -> Setup for module <AutomoxAllPackagesForAllDevicesDataPuller> has been successfully executed

Puller output

A successful initial run has the following output messages for the puller module:

Note that the PrePull action is executed only one time before the first run of the Pull action.

INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> Pull Started
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> Response received from Automox server Resource Url: https://console.automox.com/api/orgs/104944/packages
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> Total number of events: 500
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> Number of events sent to Devo: 500
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1679983458939):Number of requests made: 1; Number of events received: 500; Number of duplicated events filtered out: 0; Number of events generated and sent: 500; Average of events per second: 327.207.
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> Response received from Automox server Resource Url: https://console.automox.com/api/orgs/104944/packages
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> Total number of events: 500
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> Number of events sent to Devo: 500
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1679983458939):Number of requests made: 2; Number of events received: 1000; Number of duplicated events filtered out: 0; Number of events generated and sent: 1000; Average of events per second: 347.990.
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> Response received from Automox server Resource Url: https://console.automox.com/api/orgs/104944/packages
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> Total number of events: 500
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> Number of events sent to Devo: 500
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1679983458939):Number of requests made: 3; Number of events received: 1500; Number of duplicated events filtered out: 0; Number of events generated and sent: 1500; Average of events per second: 352.534.
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> Response received from Automox server Resource Url: https://console.automox.com/api/orgs/104944/packages
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> Total number of events: 259
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> Number of events sent to Devo: 259
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1679983458939):Number of requests made: 4; Number of events received: 1759; Number of duplicated events filtered out: 0; Number of events generated and sent: 1759; Average of events per second: 313.086.
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> Response received from Automox server Resource Url: https://console.automox.com/api/orgs/104944/packages
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> Total number of events: 0
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> No data is present on page.
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1679983458939):Number of requests made: 5; Number of events received: 1759; Number of duplicated events filtered out: 0; Number of events generated and sent: 1759; Average of events per second: 260.893.
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1679983458939):Number of requests made: 5; Number of events received: 1759; Number of duplicated events filtered out: 0; Number of events generated and sent: 1759; Average of events per second: 260.881.
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> The data is up to date!
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> Data collection completed. Elapsed time: 6.747 seconds. Waiting for 53.253 second(s) until the next one

After a successful collector’s execution (that is, no error logs found), you will see the following log message:

INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1679983458939):Number of requests made: 5; Number of events received: 1759; Number of duplicated events filtered out: 0; Number of events generated and sent: 1759; Average of events per second: 260.881.

This service does not implement persistence.

This collector has different security layers that detect both an invalid configuration and abnormal operation. This table will help you detect and resolve the most common errors.

Error type	Error ID	Error message	Cause	Solution

Error type	Error ID	Error message	Cause	Solution
SetupError	100	The remote data is not pullable with the given credentials. Check the error traces for details.	Not able to establish connection/ pull data due to incorrect credentials or account expired.	Re-check if the entered credentials are correct, and that the access token is expired or not
PullError	300	Error occurred while retrieving data from Automox server.	Invalid Api key OR Organization IDare passed.	Re-enter correct Api key/Organization ID .
PullError	301	After multiple retries still getting the too many requests error.	Automox only support 100 authenticated requests per second.	Re-run the collector after some time.
PullError	302	"Error in the request query : ___ .	Cause for this error will be you have enter invalid values in service parameters.	Check whether the parameters for that service are correct or not.
PullError	303	Api key OR Organization ID are incorrect. status code: 401. Error message: ___.	Incorrect Api key/Organization ID entered	Re-enter correct Api key/Organization ID .
PullError	304	Your Organization's subscription does not allow access to this feature.	The subscription for your Organization's could have expired or it might not have access to API functions.	Check your subscription status through the Automox portal.
PullError	305	Api key is incorrect. status code: 401. Error message: ___.	API key that you enter is expired.	Use the Automox portal to get a new API key, then provide it to the collector..
PullError	306	The resource requested is not found OR check the Organization ID. Resource Url: ___.	There are two reasons: 1.The Organization’s ID is incorrect. 2.Entity not found for that particular query.	Check the Automox site to check whether there any data for that query.
PullError	307	Some thing is wrong with the query. Please provide the correct value in config.yaml file.	Enter invalid value in config.yaml file for that service.	Check whether the parameters for that service are correct or not.
PullError	308	Currently server is unavailable to process our request.	Automox Server is not able to fulfil the request for current service.	Re-run the collector after some time.
PullError	309	Unexpected error occurred at the Automox server.	Cause for this error will be written in the Error message on the console.	As there are number of causes for this error, check on the console as the reason is described and take action accordingly.
SetupError	100	The remote data is not pullable with the given credentials. Check the error traces for details.	Not able to establish connection/ pull data due to incorrect credentials or account expired.	Re-check if the entered credentials are correct, and that the access token is expired or not
PullError	300	Error occurred while retrieving data from Automox server.	Invalid Api key OR Organization IDare passed.	Re-enter correct Api key/Organization ID .
PullError	301	After multiple retries still getting the too many requests error.	Automox only support 100 authenticated requests per second.	Re-run the collector after some time.
PullError	302	"Error in the request query : ___ .	Cause for this error will be you have enter invalid values in service parameters.	Check whether the parameters for that service are correct or not.
PullError	303	Api key OR Organization ID are incorrect. status code: 401. Error message: ___.	Incorrect Api key/Organization ID entered	Re-enter correct Api key/Organization ID .
PullError	304	Your Organization's subscription does not allow access to this feature.	The subscription for your Organization's could have expired or it might not have access to API functions.	Check your subscription status through the Automox portal.
PullError	305	Api key is incorrect. status code: 401. Error message: ___.	API key that you enter is expired.	Use the Automox portal to get a new API key, then provide it to the collector..
PullError	306	The resource requested is not found OR check the Organization ID. Resource Url: ___.	There are two reasons: 1.The Organization’s ID is incorrect. 2.Entity not found for that particular query.	Check the Automox site to check whether there any data for that query.
PullError	307	Some thing is wrong with the query. Please provide the correct value in config.yaml file.	Enter invalid value in config.yaml file for that service.	Check whether the parameters for that service are correct or not.
PullError	308	Currently server is unavailable to process our request.	Automox Server is not able to fulfil the request for current service.	Re-run the collector after some time.
PullError	309	Unexpected error occurred at the Automox server.	Cause for this error will be written in the Error message on the console.	As there are number of causes for this error, check on the console as the reason is described and take action accordingly.

Software packages by device id

Once the collector has been launched, it is important to check if the ingestion is performed in a proper way. To do so, go to the collector’s logs console.

This service has the following components:

Component	Description

Component	Description
Setup	The setup module is in charge of authenticating the service and managing the token expiration when needed.
Puller	The setup module is in charge of pulling the data in a organized way and delivering the events via SDK.

Setup output

A successful run has the following output messages for the setup module:

Puller output

A successful initial run has the following output messages for the puller module:

After a successful collector’s execution (that is, no error logs found), you will see the following log message:

This service does not implement persistence.

Collector operations

This section is intended to explain how to proceed with the specific operations of this collector.

Change log for v1.x.x

Release	Released on	Release type	Details	Recommendations

Release

Released on

Release type

Details

Recommendations

v1.0.0

Mar 17, 2023

NEW FEATURE

New features:

Released first version of Automox collector with the following services:

List Software Packages for Specific Device: Retrieves the software packages for the specified device. Packages include pending updates and currently installed updates/applications.
List All Software Packages for All Devices: This will list all pending/installed updates, and all installed applications, for all devices in a given organization.

Recommended version