Riverbed Aternity

https://help.aternity.com
Admin
Riverbed Aternity is a suite of products offering comprehensive solutions for application...
Tokens:13,490,715
Snippets:144,529
Trust Score:9.9
Update:9 months ago
Show doc for...
Tokens:
Raw
### Run Express Database Setup Script

Source: https://help.aternity.com/bundle/console_admin_guide_10x_server_local/page/console/topics/install_server_dbsvr_express_freshinstall

This command initiates the Aternity express database setup. It requires navigation to the download directory and accepts path information for Oracle software and database installations.

```bash
install.bat
```

--------------------------------

### Optional Parameters Configuration Example

Source: https://help.aternity.com/bundle/console_admin_guide_x_console_saas/page/console/topics/agent_ig_download_unified

This example demonstrates how to configure optional parameters for the Unified Agent installation, specifically setting a trusted certificate subject. Multiple parameters are separated by spaces, and values with spaces are enclosed in double quotes.

```bash
OPTIONAL_PARAMETERS="TRUSTED_CERTIFICATE_SUBJECT1=\"CN=Aternity Information Systems Ltd, O=Aternity Information Systems Ltd, L=Hod Hasharon, C=IL\""
```

```bash
OPTIONAL_PARAMETERS="key1=\"value 1, Value 1.1\" key2=\"value 2\""
```

--------------------------------

### Install Single-Node Vertica

Source: https://help.aternity.com/bundle/console_admin_guide_12_2_server_local/page/console/topics/install_server_dbsvr_vertica_freshinstall

Executes the Vertica setup script for a single-node installation. This script automates the Vertica setup process and logs output to 'installer.log'. Performance warnings related to CPU or IO can typically be ignored.

```bash
./install_single_node.sh
```

--------------------------------

### Install Agent for Mac using installer command

Source: https://help.aternity.com/bundle/console_admin_guide_y_console_saas/page/console/topics/agent_ig_install_allmacs

This snippet demonstrates how to install the Agent for Mac package using the `installer` command in the Terminal. It shows the basic syntax and provides examples for targeting different user domains.

```bash
installer -pkg mac-agent.pkg -target <target>
```

```bash
installer -pkg mac-agent.pkg -target CurrentUserHomeDirectory
```

```bash
sudo installer -pkg mac-agent.pkg -target LocalSystem
```

--------------------------------

### Execute Aternity Installation Script

Source: https://help.aternity.com/bundle/console_admin_guide_10x_server_local/page/console/topics/install_server_dbsvr_vertica_freshinstall

This snippet shows how to execute the Aternity single-node installation script. It covers running the script directly or using sudo for root permissions. The script handles Vertica setup and logs its progress.

```bash
run
./install_single_node.sh
```

```bash
sudo ./install_single_node.sh
```

--------------------------------

### Optional Parameters Syntax Example

Source: https://help.aternity.com/bundle/console_admin_guide_x_console_saas/page/console/topics/ua_modules_deploy_image

This example demonstrates the syntax for specifying optional parameters in the Unified Agent installation command. Parameters and their values must be enclosed in quotation marks, and values containing spaces require double quotation marks. Multiple parameters are separated by spaces.

```bash
OPTIONAL_PARAMETERS="TRUSTED_CERTIFICATE_SUBJECT1=\"CN=Aternity Information Systems Ltd, O=Aternity Information Systems Ltd, L=Hod Hasharon, C=IL\""
```

--------------------------------

### Use Image-based Installation to Deploy Riverbed Unified Agent and Modules

Source: https://help.aternity.com/bundle/console_admin_guide_y_console_saas/page/console/topics/console_admin_coll_details_msteams

This guide describes the process of using image-based installation methods to deploy the Riverbed Unified Agent and its associated modules. It is suitable for large-scale deployments using system imaging tools.

```text
1. Prepare a master image of your operating system with the Riverbed Unified Agent and desired modules pre-installed.
2. Ensure the agent configuration files are correctly set up within the image.
3. Use your preferred system imaging tool (e.g., SCCM, Clonezilla) to deploy this master image to target devices.
4. Upon first boot, the agent should automatically connect to the Aternity server.
```

--------------------------------

### Example VERTICA_FAILURE_THRESHOLD Configuration

Source: https://help.aternity.com/bundle/console_install_guide_12.3_server_local/page/console/topics/install_server_dbsvr_vertica_cluster

Illustrates setting the error threshold for the Vertica setup script. This determines the severity of errors that will halt the setup process. Options include HINT, WARN, FAIL, and HALT.

```bash
VERTICA_FAILURE_THRESHOLD=WARN
```

--------------------------------

### Install Aternity Agent on Windows PCs

Source: https://help.aternity.com/bundle/console_install_guide_12.3_server_local/page/console/topics/agent_ig_install_1pc

This batch file is used to launch the Aternity Agent setup on Windows PCs. It requires the MSI installer and can be configured with various parameters for deployment.

```batch
@echo off
REM Example: Aternity_Agent_xx_Install-Desktop.bat

SET MSI_FILE="Aternity_Agent_xx.msi"
SET INSTALL_DIR="C:\Program Files\Aternity"

msiexec.exe /i %MSI_FILE% /qn INSTALLDIR="%INSTALL_DIR%" ADDLOCAL=Agent DEVICE_TYPE=Desktop AGGREGATION_SERVERS=https://your_server.com

echo Agent installation initiated.
```

--------------------------------

### Install Aternity Digital Assistant with Default Parameters

Source: https://help.aternity.com/bundle/console_user_guide_y_console_saas/page/console/topics/admin_install_ada

This command installs the Aternity Digital Assistant using default parameters, inheriting agent configuration. It utilizes standard MSI parameters for setup and logging, and specifies the device type and server settings.

```batch
msiexec /I Aternity_ADA_1.0.3.8.msi /QN /L*+ Aternity_ADA_1.0.3.8_Install.LOG ADDLOCAL=ADA ADA_SERVER=<ADA-SERVER-SETTINGS> ENFORCE_PAC=True ACCOUNT=<ACCOUNT-KEY> DEVICE_TYPE=Desktop 
```

--------------------------------

### Install Vertica Cluster (Shell)

Source: https://help.aternity.com/bundle/console_admin_guide_x_console_saas/page/console/topics/install_server_dbsvr_vertica_cluster

This script installs the Vertica Database Server on the current node and all other nodes in the cluster automatically. It logs the setup process to installer.log and performs hardware requirement checks, including free disk space.

```shell
# Run the cluster installation script
./install_cluster.sh
```

--------------------------------

### Install Agent using Installer Command (Bash)

Source: https://help.aternity.com/csh_Product=console-on-premise-v12-3&topicname=agent_ig_install_allmacs

This script demonstrates how to install a Mac agent using the `installer` command. It emphasizes running the command as the local user via `su -l` and not `sudo -u`. The `<parameters>` placeholder should be replaced with actual installation parameters tested previously.

```bash
su -l $current_user -c "installer <parameters>"

```

--------------------------------

### View Software Changes with Aternity REST API v1.0

Source: https://help.aternity.com/bundle/console_user_guide_y_console_saas/page/console/topics/console_api_odata_overview

This example demonstrates how to view software changes on all devices using the Aternity REST API version 1.0. It specifies the GET request and the endpoint for the installed software change log.

```shell
curl -X GET "https://your_aternity_instance/api/v1/installedsoftware/changelog/view" \
     -H "Authorization: Bearer YOUR_API_TOKEN" \
     -H "Content-Type: application/json"
```

--------------------------------

### Set Up Aternity Digital Assistant for Sentiment Surveys on Windows Devices

Source: https://help.aternity.com/bundle/console_admin_guide_z_console_saas/page/console/topics/console_api_odata_incidents_act

This guide explains the setup process for the Aternity Digital Assistant to conduct sentiment surveys on Windows devices. It ensures the assistant is correctly installed and configured to collect user feedback.

```powershell
# Example PowerShell command to configure Digital Assistant
$ConfigPath = "C:\Program Files\Aternity\DigitalAssistant\config.json"
$NewConfig = @{
    "survey_id" = "survey-windows-123"
    "frequency_days" = 7
}

$NewConfig | ConvertTo-Json | Out-File -FilePath $ConfigPath -Encoding UTF8

# Restart the Digital Assistant service if necessary
# Restart-Service -Name "AternityDigitalAssistant"
```

--------------------------------

### Install Aternity Docker Components

Source: https://help.aternity.com/bundle/console_admin_guide_12_3_server_local/page/console/topics/install_server_dockers_freshinstall

This command initiates the installation of the Aternity Docker Components. The process may take several minutes, and completion is indicated by a '100%' status.

```bash
sudo ./aternity-docker-admin install
```

--------------------------------

### Install Required Packages for Docker Repository Setup (CentOS/RHEL)

Source: https://help.aternity.com/bundle/console_admin_guide_12_2_server_local/page/console/topics/install_server_docker_on_linux

Installs `yum-utils` for repository management and `device-mapper-persistent-data` and `lvm2` which are required by the `devicemapper` storage driver for Docker.

```bash
$ sudo yum install -y yum-utils \
        device-mapper-persistent-data \
        lvm2

```

--------------------------------

### Unified Agent Command-Line Setup (Desktop, Virtual Desktop, Server)

Source: https://help.aternity.com/bundle/console_admin_guide_x_console_saas/page/console/topics/ua_modules_deploy_image

This command is used to install the Aternity Unified Agent across all devices in an organization or on specific computers. It requires specifying the device type and the SaaS application URL. The command should be copied and pasted into the command line of your software distribution system.

```bash
msiexec /I Unified_Agent_[version].msi /QN /log*v Unified_Agent_[version].msi.log DEVICE_TYPE=[type] TARGET_URL=http://[domain] ACCOUNT=[key]
```

--------------------------------

### Distinct Count Example

Source: https://help.aternity.com/bundle/console_user_guide_x_console_saas/page/console/topics/console_api_odata_overview

Example demonstrating how to get a distinct count of items using the $count and $select parameters.

```APIDOC
## GET /applications_daily with $count

### Description
Retrieves the distinct count of applications used within a specified time frame. This query uses `$select` to specify the attribute for counting and `$count=true` to enable the count.

### Method
GET

### Endpoint
`/<base_url>/aternity.odata/latest/applications_daily`

### Parameters
#### Query Parameters
- **$filter** (string) - Required - Filters the data by time. Example: `$filter=relative_time(last_7_days)`
- **$select** (string) - Required - Specifies the attribute(s) to count. Example: `$select=application_name`
- **$count** (boolean) - Required - Set to `true` to get the distinct count. Example: `$count=true`
- **$top** (integer) - Set to `0` when using `$count` to retrieve only the count.

### Request Example
```
.../aternity.odata/latest/applications_daily?$filter=relative_time(last_7_days)&$select=application_name&$count=true&$top=0
```

### Response
#### Success Response (200)
- **@odata.count** (integer) - The total distinct count of the selected attribute.

#### Response Example
```json
{
  "@odata.count": 150
}
```
```

--------------------------------

### Install Module with Optional Parameters (Command Line)

Source: https://help.aternity.com/bundle/console_admin_guide_x_console_saas/page/console/topics/ua_modules_deploy_mdmtools

This command installs a module using the Unified Agent installer with specified optional parameters. It requires the module name, version, file path, account key, and additional arguments for device type, aggregation servers, enforce PAC, and trusted certificates. Ensure all parameters and their values are correctly quoted and separated by commas.

```bash
"%programfiles%\Riverbed\UnifiedAgent\ModuleInstaller.exe" 					--install --module Aternity_Windows_Amd64 --version 25.1.0.8 					--file Aternity_Agent_25.1.0.8.msi --key K3Lzn0 --args 					"ADDLOCAL=Agent DEVICE_TYPE={deviceType} 					AGGREGATION_SERVERS={serviceUrl},{proxyUrl} 					ENFORCE_PAC={enforcePac} ACCOUNT={accountKey} 					ACTION_EXECUTION_POLICY=Trusted 					TRUSTED_CERTIFICATE_SUBJECT1=\"XXXX\""
```

--------------------------------

### Run Vertica Setup Script for Cluster Installation

Source: https://help.aternity.com/bundle/console_user_guide_12_3_server_local/page/console/topics/install_server_dbsvr_vertica_cluster

The Vertica Setup Script automates the installation and configuration of Vertica on the current computer and all other nodes in the cluster. This script should be run only once after the SSH script has successfully established secure communication or if manual password entry is required.

```shell
#!/bin/bash
# This script sets up Vertica on the current node and other cluster nodes.
# It should be run once after SSH setup or when manual password entry is needed.

# Example command (actual command would involve sourcing parameters and executing Vertica setup)
# source ./_vertica_parameters.sh
# /opt/vertica/bin/vertica-setup --config-file /path/to/vertica_config.yaml
```

--------------------------------

### HOST_RESOURCES_DAILY API Example

Source: https://help.aternity.com/bundle/console_admin_guide_y_console_saas/page/console/topics/console_api_odata_hrc_daily_v1

An example demonstrating how to use the HOST_RESOURCES_DAILY API to analyze CPU utilization by various device attributes.

```APIDOC
## HOST_RESOURCES_DAILY API Example

### Description
This example shows how to access the `HOST_RESOURCES_DAILY` API to analyze CPU usage patterns across different laptop models and locations. It filters for 'Laptop' devices and selects specific attributes for analysis.

### Endpoint
`<base_url>/HOST_RESOURCES_DAILY`

### Example Query
To analyze which laptop model uses too much CPU and troubleshoot the reasons for that issue, use this syntax to compare laptop CPU use aggregated by business location, device model, number of CPU cores, CPU frequency, and OS version:

`.../HOST_RESOURCES_DAILY?$filter=SERVING_DEVICE_TYPE eq 'Laptop'&$select=BUSINESS_LOCATION,DEVICE_MODEL,CPU_CORES,CPU_FREQUENCY,OS_VERSION,CPU_UTILIZATION_AVG`
```

--------------------------------

### Configure Vertica Installation Parameters

Source: https://help.aternity.com/bundle/console_admin_guide_x_console_saas/page/console/topics/install_server_dbsvr_vertica_cluster

This file contains essential parameters for the Vertica setup script. Key parameters include `RUN_AS_USER` for specifying the user with sudo privileges on cluster nodes, `PASSWORDLESS_INSTALLATION` to control SSH password prompts, and `VERTICA_TZ` for setting the server's time zone. Ensure these are configured correctly for a successful installation.

```bash
# Example configuration for vertica_parameters.sh
RUN_AS_USER="your_sudo_user"
PASSWORDLESS_INSTALLATION="YES"
VERTICA_TZ="UTC"
```

--------------------------------

### Aternity REST API (ODATA) Query Examples

Source: https://help.aternity.com/bundle/console_admin_guide_x_console_saas/page/console/topics/admin_create_groups

Examples of constructing queries for the Aternity REST API (ODATA) to populate entity groups. These examples demonstrate filtering by operating system and installed software.

```SQL
API name: device_inventory
Query options: filter=os_name eq 'MS Windows 11'
```

```SQL
API name: installed_software
Query options: filter=contains(installed_sw_name,'Microsoft Outlook') or contains(installed_sw_name,'Microsoft Teams')
```

--------------------------------

### View Deployed Applications on All Devices with Aternity REST API v1.0

Source: https://help.aternity.com/bundle/console_user_guide_y_console_saas/page/console/topics/console_admin_app

This example shows how to query the Aternity REST API (version 1.0) to get a list of all applications deployed across managed devices. This is useful for software inventory and compliance. The API returns a list of applications, their versions, and the devices they are installed on.

```bash
curl -X GET "https://<your_aternity_instance>/api/v1/devices/installed_software" \
     -H "Authorization: Bearer <your_api_token>"
```

--------------------------------

### Example VERTICA_SIZE Configuration

Source: https://help.aternity.com/bundle/console_install_guide_12.3_server_local/page/console/topics/install_server_dbsvr_vertica_cluster

Provides examples of setting the Aternity deployment size for Vertica. This impacts the resource requirements for the Vertica Database Server. Valid options range from TRIAL to XXLARGE.

```bash
VERTICA_SIZE=MEDIUM
```

--------------------------------

### GET /api/installed_software

Source: https://help.aternity.com/bundle/console_user_guide_x_console_saas/page/console/topics/console_api_odata_app_raw_v1

View deployed applications on all devices (Installed Software). This endpoint provides a list of installed software on devices.

```APIDOC
## GET /api/installed_software

### Description
View deployed applications on all devices (Installed Software).

### Method
GET

### Endpoint
/api/installed_software

### Parameters
#### Query Parameters
- **$filter** (string) - Optional - OData filter to narrow down the results.
- **$top** (integer) - Optional - Maximum number of results to return.
- **$skip** (integer) - Optional - Number of results to skip.
- **$orderby** (string) - Optional - Field to order the results by.
- **$select** (string) - Optional - Fields to select in the results.

### Request Example
```json
{
  "example": "/api/installed_software?$filter=ApplicationName eq 'Chrome'"
}
```

### Response
#### Success Response (200)
- **value** (array) - An array of installed software objects.

#### Response Example
```json
{
  "value": [
    {
      "DeviceName": "MyLaptop",
      "ApplicationName": "Chrome"
    }
  ]
}
```
```

--------------------------------

### GET /api/installed_software

Source: https://help.aternity.com/bundle/console_user_guide_x_console_saas/page/console/topics/admin_config_avd

Views deployed applications on all devices (Installed Software).

```APIDOC
## GET /api/installed_software

### Description
Views deployed applications on all devices (Installed Software).

### Method
GET

### Endpoint
/api/installed_software

### Parameters
#### Query Parameters
- **$filter** (string) - Optional - OData filter to narrow down the results.
- **$top** (integer) - Optional - Maximum number of results to return.
- **$skip** (integer) - Optional - Number of results to skip.

### Request Example
```json
{
  "example": "/api/installed_software?$filter=ApplicationName eq 'Chrome'"
}
```

### Response
#### Success Response (200)
- **value** (array) - An array of installed software objects.

#### Response Example
```json
{
  "value": [
    {
      "DeviceName": "PC-001",
      "ApplicationName": "Chrome"
    }
  ]
}
```
```

--------------------------------

### Unified Agent Command-Line Installation Parameters

Source: https://help.aternity.com/bundle/release_news_agent_console_saas/page/console/topics/agent_ig_download_unified

This section details the parameters used for installing the Unified Agent via the command line. It explains DEVICE_TYPE, TARGET, ACCOUNT, and OPTIONAL_PARAMETERS, including syntax rules for the latter. It also covers the IMAGE_MODE parameter specific to Windows installations.

```bash
OPTIONAL_PARAMETERS="TRUSTED_CERTIFICATE_SUBJECT1=\"CN=Aternity Information Systems Ltd, O=Aternity Information Systems Ltd, L=Hod Hasharon, C=IL\""
OPTIONAL_PARAMETERS="key1=value1"
OPTIONAL_PARAMETERS="key1=\"value 1\" key2=\"value 2\""
OPTIONAL_PARAMETERS="key1=\"value 1, Value 1.1\" key2=\"value 2\""
```

```bash
msiexec /I Unified_Agent_[version].msi /QN /log*v Unified_Agent_[version].msi.log DEVICE_TYPE=[type] TARGET_URL=http://[domain] ACCOUNT=[key] IMAGE_MODE=Create
```

--------------------------------

### Install Docker CE (CentOS/RHEL)

Source: https://help.aternity.com/bundle/console_admin_guide_12_2_server_local/page/console/topics/install_server_docker_on_linux

Installs the latest stable version of Docker CE from the configured repositories. This command fetches and installs the Docker engine and its necessary components.

```bash
$ sudo yum install docker-ce

```

--------------------------------

### Manual Module Installation

Source: https://help.aternity.com/bundle/release_news_2026_1_console_saas/page/console/topics/ua_modules_deploy_image_mode

This sequence of commands and actions is part of the optional module installation process. It involves running an executable, stopping services, deleting specific registry values, and clearing log and database folders.

```bash
moduleInstaller.exe
```

```powershell
Stop-Service -Name A180WD, A180AA -ErrorAction SilentlyContinue
```

```powershell
Remove-ItemProperty -Path "HKLM:\SOFTWARE\WOW6432Node\Aternity\A180\[agent_ver]\Runtime" -Name EventLogPlugin.LastTimestamp -ErrorAction SilentlyContinue
```

```powershell
Remove-ItemProperty -Path "HKLM:\SOFTWARE\WOW6432Node\Aternity\A180\[agent_ver]\Runtime" -Name DumpAnalyzer.LastTimestamp -ErrorAction SilentlyContinue
```

```powershell
Remove-Item -Path "C:\ProgramData\Aternity\Logs" -Recurse -Force
```

```powershell
Remove-Item -Path "C:\ProgramData\Aternity\Database" -Recurse -Force
```

--------------------------------

### GET /latest/INSTALLED_SOFTWARE

Source: https://help.aternity.com/bundle/console_user_guide_npm_console_npm/page/console/topics/console_api_odata_installed_software

Retrieves a list of installed software. You can access all attributes or specify which ones to return.

```APIDOC
## GET /latest/INSTALLED_SOFTWARE

### Description
Retrieves a list of installed software. You can access all attributes or specify which ones to return.

### Method
GET

### Endpoint
`/latest/INSTALLED_SOFTWARE`

### Query Parameters
- **$select** (string) - Optional - Comma-separated list of attributes to return. Example: `Device_Name,Installed_Sw_Last_Change_Timestamp,Installed_Sw_Name`

### Request Example
`https://<base_url>/latest/INSTALLED_SOFTWARE`
`https://<base_url>/latest/INSTALLED_SOFTWARE?$select=Device_Name,Installed_Sw_Last_Change_Timestamp,Installed_Sw_Name`

### Response
#### Success Response (200)
- **Device_Name** (string) - The name of the device.
- **Installed_Sw_Last_Change_Timestamp** (string) - The timestamp of the last change for the installed software.
- **Installed_Sw_Name** (string) - The name of the installed software.
- **Account_ID** (string) - The account identifier.
- **Device_Count** (integer) - The count of devices.
- **Installed_Sw_Count** (integer) - The count of installed software.
- **Installed_Sw_Installation_Volume** (string) - The installation volume of the software.
- **Installed_Sw_Related_To** (string) - Information about related software.
- **Installed_Sw_Scope** (string) - The scope of the installed software.
- **Installed_Sw_Type** (string) - The type of the installed software.
- **Installed_Sw_Vendor** (string) - The vendor of the installed software.
- **Installed_Sw_Version** (string) - The version of the installed software.
- **Installed_Sw_Version_Count** (integer) - The count of software versions.
- **Account_Name** (string) - The name of the account.

#### Response Example
```json
{
  "Device_Name": "ExampleDevice1",
  "Installed_Sw_Last_Change_Timestamp": "2023-10-27T10:00:00Z",
  "Installed_Sw_Name": "ExampleSoftware",
  "Account_ID": "acc123",
  "Device_Count": 1,
  "Installed_Sw_Count": 1,
  "Installed_Sw_Installation_Volume": "100MB",
  "Installed_Sw_Related_To": "None",
  "Installed_Sw_Scope": "Global",
  "Installed_Sw_Type": "Application",
  "Installed_Sw_Vendor": "ExampleVendor",
  "Installed_Sw_Version": "1.0.0",
  "Installed_Sw_Version_Count": 1,
  "Account_Name": "ExampleAccount"
}
```
```

--------------------------------

### Install Aternity Docker Components

Source: https://help.aternity.com/bundle/console_admin_guide_12_2_server_local/page/console/topics/install_server_dockers_freshinstall_nonroot

Initiates the installation process for Aternity Docker Components. This command should be run from the installer folder and may take several minutes to complete, indicated by a '100%' status.

```bash
./aternity-docker-admin install

```

--------------------------------

### Aternity APM Agent Setup Script Download Command (Linux)

Source: https://help.aternity.com/bundle/release_news_apm_agent_console_apm/page/console/topics/apm_unattended_deploy

This command downloads the Aternity APM agent setup script from the specified URL. This script is a prerequisite for the unattended installation process on Linux systems. It requires `curl` to be installed on the server.

```shell
curl -fsS https://*/install-agent.sh
```

--------------------------------

### Run Aternity Single Node Installation Script

Source: https://help.aternity.com/bundle/console_install_servers_guide_10_server_local/page/console/topics/install_server_dbsvr_vertica_freshinstall

Executes the Aternity single-node installation script. This script automates the Vertica setup process. It can be run with or without sudo privileges.

```Shell
# Navigate to the download folder
cd /path/to/download/folder

# Run the installation script
./install_single_node.sh

# Run with sudo privileges if necessary
sudo ./install_single_node.sh
```

--------------------------------

### Install Aternity Agent with MSI Parameters (Windows)

Source: https://help.aternity.com/bundle/console_admin_guide_12_2_server_local/page/console/topics/agent_ig_install_conf

This command installs the Aternity Agent using its MSI package with various configuration parameters. Standard MSI parameters like /I, /QN, and /L*V+ are required for setup and logging. Additional parameters customize features, device type, server addresses, and privacy settings.

```batch
msiexec /I Aternity_Agent_x.msi /QN /L*V+ logfilename.log ADDLOCAL=Agent DEVICE_TYPE=Desktop AGGREGATION_SERVERS=hostname
```

--------------------------------

### Analyze Application Performance Daily Anonymized with Aternity REST API v2

Source: https://help.aternity.com/bundle/console_user_guide_12_2_server_local/page/console/topics/console_admin_coll_app_resources

This example shows how to get anonymized daily application performance data using the Aternity REST API v2. This is useful for privacy-conscious analysis of application usage and performance. The API returns daily performance data without PII.

```shell
GET /api/v2/applicationperformance/daily/anonymized
```

--------------------------------

### HOST_RESOURCES_HOURLY API Examples

Source: https://help.aternity.com/bundle/console_user_guide_npm_console_npm/page/console/topics/console_api_odata_hrc

Examples demonstrating how to access the HOST_RESOURCES_HOURLY API and use query parameters like $select and $filter for specific data retrieval.

```APIDOC
## HOST_RESOURCES_HOURLY API Examples

### Description
Examples demonstrating how to access the HOST_RESOURCES_HOURLY API and use query parameters like `$select` and `$filter` for specific data retrieval.

### Accessing the API
To access this API from a browser, Excel or Power BI, enter:
- `<base_url>/latest/HOST_RESOURCES_HOURLY`
- or `<base_url>/v2/HOST_RESOURCES_HOURLY`

### Example 1: Filter by Device Model
To view the CPU usage of all _Thinkpad_ models across different locations, enter:
`.../HOST_RESOURCES_HOURLY?$select=BUSINESS_LOCATION,CPU_UTILIZATION_AVG&$filter=contains(DEVICE_MODEL,'ThinkPad')`

### Example 2: Filter by CPU Usage and Uptime
To return the list of users and their departments where their devices consumed on average more than 25 percent CPU and did not reboot for over 30 days, enter:
`.../HOST_RESOURCES_HOURLY?$select=USERNAME,USER_DEPARTMENT&$filter=CPU_UTILIZATION_AVG gt 25 and DAYS_FROM_LAST_BOOT eq 'More than 30 days'`
```

--------------------------------

### Query Aternity REST API for Device Boot Times

Source: https://help.aternity.com/bundle/console_user_guide_12_2_server_local/page/console/topics/console_api_odata_boottimes_v1

This example demonstrates how to construct a URL to query the Aternity REST API for Windows machine boot times. It includes placeholders for the base URL and API name, and suggests using query parameters like $select and $filter for optimization. Authentication details for LDAP and SSO users are also noted.

```URL
http://odata-aternity.company.com:80/aternity.odata/WINDOWS_MACHINE_BOOTS?$select=Duration,Type,User,Location,Device&$filter=Type eq 'Machine Boot' and relative_time eq '1d'
```

--------------------------------

### GET /api/installed_software

Source: https://help.aternity.com/bundle/console_user_guide_x_console_saas/page/console/topics/a_conrefs_odata_columns

View deployed applications on all devices (Installed Software).

```APIDOC
## GET /api/installed_software

### Description
View deployed applications on all devices (Installed Software).

### Method
GET

### Endpoint
/api/installed_software

### Parameters
#### Query Parameters
- **$top** (integer) - Optional - Specifies the maximum number of results to return.
- **$skip** (integer) - Optional - Specifies the number of items to skip.
- **$filter** (string) - Optional - Filters the results based on specified criteria.
- **$orderby** (string) - Optional - Orders the results based on specified fields.
- **$select** (string) - Optional - Selects specific fields to return.

### Request Example
```json
{
  "example": "/api/installed_software?$top=10&$skip=0"
}
```

### Response
#### Success Response (200)
- **value** (array) - An array of installed software objects.

#### Response Example
```json
{
  "@odata.context": "$metadata#InstalledSoftware",
  "value": [
    {
      "DeviceName": "string",
      "SoftwareName": "string",
      "Version": "string"
    }
  ]
}
```
```

--------------------------------

### Retrieve Specific Data with Filtering and Formatting

Source: https://help.aternity.com/bundle/console_install_guide_y_console_saas/page/console/topics/console_api_odata_overview

This example demonstrates how to retrieve specific data by using query parameters like $select, $filter, and $format. It shows how to filter by username, device name, application, and time range, and how to select specific columns.

```URL
https://my-odata.aternity.com/aternity.odata/latest/BUSINESS_ACTIVITIES_HOURLY
https://us2-odata.aternity.com/aternity.odata/latest/BUSINESS_ACTIVITIES_HOURLY
https://eu-odata.aternity.com/aternity.odata/latest/BUSINESS_ACTIVITIES_HOURLY
.../API_NAME?$filter=(USERNAME eq 'jsmith@company.com')
.../API_NAME?$format=xml& $top=5
<base_url>/latest/APPLICATIONS_HOURLY?$select=timeframe,UXI&filter=(SERVING_DEVICE_NAME eq 'hostname') and relative_time(last_24_hours) and APPLICATION eq 'Microsoft Word'
```

--------------------------------

### Query Device Boot Times with Filters (Aternity REST API)

Source: https://help.aternity.com/bundle/console_admin_guide_12_2_server_local/page/console/topics/console_api_odata_boottimes

These examples demonstrate how to query the WINDOWS_MACHINE_BOOTS API to retrieve specific boot time data. They utilize `$select` to specify columns and `$filter` to narrow down results by boot type, duration, and device attributes. This helps in troubleshooting performance issues and correlating boot times with hardware or software configurations.

```URL
.../WINDOWS_MACHINE_BOOTS?$select=DEVICE_MEMORY,DEVICE_MANUFACTURER,DEVICE_MODEL&$filter=TYPE eq 'Total Boot Duration' and DURATION gt 40
```

```URL
.../WINDOWS_MACHINE_BOOTS?$select=OS_VERSION&$filter=TYPE eq 'Total Boot Duration' and DURATION gt 40
```

```URL
.../WINDOWS_MACHINE_BOOTS?$select=DURATION,TIMEFRAME&$filter=relative_time(last_14_days) and TYPE eq 'User Logon' and contains(USERNAME,'jsmith')
```

--------------------------------

### Get Distinct Attribute Combinations Count with $count

Source: https://help.aternity.com/bundle/console_admin_guide_x_console_saas/page/console/topics/console_api_odata_custom_data_raw

This example shows how to get a distinct count of 'application_name' and 'username' combinations for data within the last 7 days using $count=true and $select.

```url
.../aternity.odata/latest/applications_daily?$filter=relative_time(last_7_days)&$select=select=application_name,username&$count=true&$top=0
```

--------------------------------

### Configure Vertica Database Parameters

Source: https://help.aternity.com/bundle/console_admin_guide_10x_server_local/page/console/topics/install_server_dbsvr_vertica_cluster

This snippet shows an example of how to configure the `vertica_parameters.sh` file. Key parameters include `RUN_AS_USER` for the execution user, `VERTICA_TZ` for the time zone, `VERTICA_DATA_DIR` for the data directory, `VERTICA_NODE_1` for the primary node's IP, `VERTICA_OTHER_NODES` for other cluster nodes, and `VERTICA_DB_NAME` for the database name. Ensure these parameters match your cluster environment.

```bash
# Example configuration for vertica_parameters.sh
RUN_AS_USER="your_username"
VERTICA_TZ="UTC"
VERTICA_DATA_DIR="/data/vertica"
VERTICA_NODE_1="10.0.0.101"
VERTICA_OTHER_NODES=("10.0.0.102" "10.0.0.103")
VERTICA_DB_NAME="aternity"
```

--------------------------------

### Manual Module Installation

Source: https://help.aternity.com/bundle/release_news_2025_12_console_saas/page/console/topics/ua_modules_deploy_image_mode

This section outlines the manual steps for installing Unified Agent modules, specifically the Aternity module. It involves running a module installer, stopping services, deleting specific registry values, and clearing log and database folders.

```bash
moduleInstaller.exe
```

```powershell
Stop-Service -Name A180WD, A180AA -ErrorAction SilentlyContinue
```

```powershell
Remove-ItemProperty -Path "HKLM:\SOFTWARE\WOW6432Node\Aternity\A180\[agent_ver]\Runtime" -Name "EventLogPlugin.LastTimestamp" -ErrorAction SilentlyContinue
```

```powershell
Remove-ItemProperty -Path "HKLM:\SOFTWARE\WOW6432Node\Aternity\A180\[agent_ver]\Runtime" -Name "DumpAnalyzer.LastTimestamp" -ErrorAction SilentlyContinue
```

```powershell
Remove-Item -Path "C:\ProgramData\Aternity\Logs" -Recurse -Force -ErrorAction SilentlyContinue
```

```powershell
Remove-Item -Path "C:\ProgramData\Aternity\Database" -Recurse -Force -ErrorAction SilentlyContinue
```

--------------------------------

### Analyze Daily Device Resource Usage (HRC) Anonymized with Aternity REST API v2

Source: https://help.aternity.com/bundle/console_user_guide_12_2_server_local/page/console/topics/console_admin_coll_app_resources

This example shows how to get anonymized daily device resource usage data using the Aternity REST API v2. This is useful for privacy-preserving performance analysis. The API returns daily resource usage metrics without PII.

```shell
GET /api/v2/deviceresourceusage/daily/anonymized
```

--------------------------------

### Download Agent for End User Devices (Agent Deployment)

Source: https://help.aternity.com/bundle/console_admin_guide_z_console_saas/page/console/topics/console_api_odata_reporting_agents_v1

This section provides instructions on downloading the Aternity agent for end-user devices. It covers the necessary steps to obtain the agent installer and prepare for deployment.

```powershell
# Example PowerShell command to download a file from a URL
# Replace with the actual Aternity agent download URL

$agentUrl = "https://download.aternity.example.com/agent/aternity_agent_installer.msi"
$outputPath = "C:\\Temp\\aternity_agent_installer.msi"

Write-Host "Downloading Aternity agent from $agentUrl to $outputPath..."

try {
    Invoke-WebRequest -Uri $agentUrl -OutFile $outputPath -UseBasicParsing
    Write-Host "Download complete."
} catch {
    Write-Error "Failed to download agent. Error: $($_.Exception.Message)"
}
```

--------------------------------

### GET /api/installed_software_change_log (version 2.0)

Source: https://help.aternity.com/bundle/console_user_guide_x_console_saas/page/console/topics/generic_retention

This endpoint allows you to view software changes on all devices. It provides a log of installed software changes, including installations, updates, and removals.

```APIDOC
## GET /api/installed_software_change_log

### Description
Retrieves the software change log for all devices, providing details on software installations, updates, and removals.

### Method
GET

### Endpoint
/api/installed_software_change_log

### Parameters
#### Query Parameters
- **start_date** (string) - Optional - The start date for the log entries (YYYY-MM-DD).
- **end_date** (string) - Optional - The end date for the log entries (YYYY-MM-DD).
- **device_id** (integer) - Optional - Filter by a specific device ID.

### Request Example
```json
{
  "start_date": "2024-01-01",
  "end_date": "2024-01-31"
}
```

### Response
#### Success Response (200)
- **changes** (array) - An array of software change log entries.
  - **device_id** (integer) - The ID of the device.
  - **software_name** (string) - The name of the software.
  - **change_type** (string) - The type of change (e.g., installed, updated, removed).
  - **timestamp** (string) - The timestamp of the change.

#### Response Example
```json
{
  "changes": [
    {
      "device_id": 123,
      "software_name": "Microsoft Office",
      "change_type": "installed",
      "timestamp": "2024-01-15T10:00:00Z"
    }
  ]
}
```
```

--------------------------------

### HOST_RESOURCES_DAILY API Example

Source: https://help.aternity.com/bundle/console_admin_guide_mobile_console_saas/page/console/topics/console_api_odata_hrc_daily

Example of how to query the HOST_RESOURCES_DAILY API, focusing on selecting specific attributes and measurements.

```APIDOC
## HOST_RESOURCES_DAILY API

### Description
Retrieves average resource usage for devices on a daily basis. Using `$select` can optimize queries by grouping identical attribute values.

### Endpoint
`/websites/help_aternity/HOST_RESOURCES_DAILY` (Illustrative endpoint)

### Parameters

#### Query Parameters

*   **`$filter`** (string) - Optional - Filters the results based on specified criteria using supported functions like `startswith`, `contains`, `in()`, and logical operators.
*   **`$select`** (string) - Optional - Specifies the columns (Attributes and Measurements) to include in the response. Selecting fewer columns can speed up queries.
*   **`relative_time`** (string) - Optional - Defines the time range for the data. Defaults to the last 7 days if not specified.

### Request Example

```http
GET /websites/help_aternity/HOST_RESOURCES_DAILY?$select=Device_Name,HRC_CPU_Util_Avg,Calendar_Date&$filter=contains(Device_Name,'Workstation') and relative_time(last_24_hours)
```

### Response

#### Success Response (200)

*   **Attributes**: Columns representing properties of an entry (e.g., `Device_Name`, `Calendar_Date`).
*   **Measurements**: Columns representing dynamic measured values (e.g., `HRC_CPU_Util_Avg`, `Network_Read_Avg`).

#### Response Example

```json
[
  {
    "Device_Name": "Desktop-123",
    "HRC_CPU_Util_Avg": 25.5,
    "Calendar_Date": "2023-10-27"
  },
  {
    "Device_Name": "Laptop-456",
    "HRC_CPU_Util_Avg": 15.2,
    "Calendar_Date": "2023-10-27"
  }
]
```

### Available Columns

#### Measurements
*   `Device_Hours_Running_Total`
*   `HRC_CPU_Util_Avg`
*   `HRC_Disk_IO_Read_Rate_Avg`
*   `HRC_Disk_IO_Write_Rate_Avg`
*   `HRC_Disk_Queue_Length_Max`
*   `HRC_Virtual_Memory_Util_Avg`
*   `HRC_Physical_Memory_Util_Avg`
*   `Network_Read_Avg`
*   `Network_Write_Avg`

#### Attributes
*   `Account_ID`
*   `Business_Location`
*   `Calendar_Date`
*   `Calendar_Month`
*   `Calendar_Week`
*   `Corp_Channel`
*   `Corp_Line_Of_Business`
*   `Corp_Market`
*   `Corp_Store_ID`
*   `Corp_Store_Type`
*   `Custom_Attribute (1-6 or 1-9)`
*   `Custom_Pilot_Group`
*   `Custom_User_Attribute (1-9)`
*   `Data_Center_Location` (or `Data_Center_Business_Location`)
*   `Device_CPU_Cores`
*   `Device_CPU_Frequency`
*   `Device_CPU_Generation`
*   `Device_CPU_Model` (a.k.a. `CPU_Model`)
*   `Device_CPU_Type`
*   `Device_Days_From_Last_Boot`
*   `Device_Domain`
*   `Device_Idle_This_Hour`
*   `Device_Image_Build_Number`
*   `Device_ISP`
*   `Device_Manufacturer`
*   `Device_Memory`
*   `Device_Model`
*   `Device_Name`
*   `Device_Network_Type`
*   `Device_Power_Plan`
*   `Device_Subnet`
*   `Device_Type`
*   `Location_City`
*   `Location_Country`
*   `Location_On_Site`
*   `Location_On_VPN`
*   `Location_Region`
*   `Location_State`
*   `MS_Office_License_Type`
*   `MS_Office_Version`
*   `MS_Stability_Index`
*   `OS_Architecture`
*   `OS_Disk_Type`
*   `OS_Family`
*   `OS_Free_Disk_Space`
*   `OS_Name`
*   `OS_Version`
*   `Timeframe`
*   `User_Department`
*   `User_Domain`
*   `User_Email_Address`
*   `User_Full_Name`
*   `User_Office`
*   `User_Role`
*   `User_Title`
*   `Username`
*   `Wifi_BSSID`
*   `Wifi_Channel`
*   `Wifi_SSID`
*   `Account_Name`

```

--------------------------------

### GET /api/installed_software (version 2.0)

Source: https://help.aternity.com/bundle/console_user_guide_12_2_server_local/page/z_generic/gloss_MOS

Views deployed applications on all devices, providing a comprehensive list of installed software.

```APIDOC
## GET /api/installed_software (version 2.0)

### Description
Views deployed applications on all devices.

### Method
GET

### Endpoint
/api/installed_software

### Parameters
#### Query Parameters
- **device_name** (string) - Optional - The name of the device to filter by.

### Request Example
```json
{
  "device_name": "PC123"
}
```

### Response
#### Success Response (200)
- **installed_software** (array) - An array of installed software objects.

#### Response Example
```json
{
  "installed_software": [
    {
      "device_name": "PC123",
      "software_name": "Microsoft Office",
      "version": "16.0"
    }
  ]
}
```
```

--------------------------------

### Filter and Select Data for Laptop CPU Analysis

Source: https://help.aternity.com/bundle/console_user_guide_12_2_server_local/page/console/topics/console_api_odata_hrc_daily_anon_v1

This example demonstrates how to filter data for laptops within the last 200 days and select specific attributes for CPU utilization analysis. It showcases the use of $filter with relative_time and $select for targeted data retrieval.

```URL
`.../HOST_RESOURCES_DAILY_ANONYMIZED?$filter=SERVING_DEVICE_TYPE eq 'Laptop' and relative_time(last_200_days)&$select=BUSINESS_LOCATION,DEVICE_MODEL,CPU_CORES,CPU_FREQUENCY,OS_VERSION,CPU_UTILIZATION_AVG`
```

--------------------------------

### Install Agent for Mac using Installer Command (Shell)

Source: https://help.aternity.com/bundle/console_admin_guide_y_console_saas/page/console/topics/agent_ig_install_allmacs

This command installs the Agent for Mac package. It uses 'su' to run the installer as the specified user, with verbose logging and log dumping enabled. The '-pkg' parameter points to the installer package, and '-target' specifies the installation directory.

```shell
su -l $this_user -c "/usr/sbin/installer -verboseR -dumplog -pkg /Users/$this_user/mac-agent.pkg -target CurrentUserHomeDirectory"
```

--------------------------------

### Regular Expression Example for URL Matching

Source: https://help.aternity.com/bundle/console_admin_guide_12_3_server_local/page/console/topics/console_admin_app_web_config

An example demonstrating how to use regular expressions to precisely match a URL, including anchors for the start and end of the string. This prevents unintended matches with similar patterns, such as ad redirects.

```regex
^http://company.com/…$
```

--------------------------------

### Configure ActiveMQ Heap Size (Windows Batch)

Source: https://help.aternity.com/bundle/console_admin_guide_y_console_saas/page/console/topics/all_xg_hw_jvm

This example demonstrates how to set the `ACTIVEMQ_OPTS` in the `activemq.bat` file for the Aternity Management Server. It specifically shows how to set the initial heap size (`-Xms`) and maximum heap size (`-Xmx`) to be identical, for example, 1GB.

```batch
set ACTIVEMQ_OPTS=**-Xms1G -Xmx1G** -Djava.util.logging.config.file=...
```

--------------------------------

### Querying Boot Time Correlations

Source: https://help.aternity.com/bundle/console_install_guide_y_console_saas/page/console/topics/console_api_odata_boottimes

Examples of how to query the WINDOWS_MACHINE_BOOTS endpoint to find correlations between boot times and device specifications or OS versions.

```APIDOC
## Querying Boot Time Correlations

### Description
Examples of how to query the WINDOWS_MACHINE_BOOTS endpoint to find correlations between boot times and device specifications or OS versions.

### Method
GET

### Endpoint
/WINDOWS_MACHINE_BOOTS

### Parameters
#### Query Parameters
- **$select** (string) - Required - Specifies the fields to return in the response.
- **$filter** (string) - Required - Filters the results based on specified criteria.

### Request Examples

1. **Correlation between long boot times and device RAM, manufacturer, and model:**
```
<base_url>/WINDOWS_MACHINE_BOOTS?$select=DEVICE_MEMORY,DEVICE_MANUFACTURER,DEVICE_MODEL&$filter=Measurement_Type eq 'Total Boot Duration' and Measurement_Duration_Avg gt 40
```

2. **Correlation between Windows version and long boot times:**
```
<base_url>/WINDOWS_MACHINE_BOOTS?$select=OS_VERSION&$filter=Measurement_Type eq 'Total Boot Duration' and Measurement_Duration_Avg gt 40
```

3. **Trend of boot times for a specific user during the past two weeks (User Logon):**
```
<base_url>/WINDOWS_MACHINE_BOOTS?$select=Measurement_Duration_Avg,TIMEFRAME&$filter=relative_time(last_14_days) and Measurement_Type eq 'User Logon' and contains(USERNAME,'jsmith')
```

### Response
#### Success Response (200)
- **DEVICE_MEMORY** (string) - The amount of RAM on the device.
- **DEVICE_MANUFACTURER** (string) - The manufacturer of the device.
- **DEVICE_MODEL** (string) - The model number of the device.
- **OS_VERSION** (string) - The version of the Windows operating system.
- **Measurement_Duration_Avg** (number) - The average duration of the measurement in seconds.
- **TIMEFRAME** (string) - The time frame for the measurement.
- **USERNAME** (string) - The username associated with the boot session.

#### Response Example (for query 1)
```json
{
  "value": [
    {
      "DEVICE_MEMORY": "8GB",
      "DEVICE_MANUFACTURER": "Dell",
      "DEVICE_MODEL": "Latitude 7400"
    },
    {
      "DEVICE_MEMORY": "16GB",
      "DEVICE_MANUFACTURER": "HP",
      "DEVICE_MODEL": "EliteBook 840"
    }
  ]
}
```
```

--------------------------------

### GET /REMEDIATION_ACTIONS_INVENTORY

Source: https://help.aternity.com/bundle/console_admin_guide_z_console_saas/page/console/topics/generic_retention

Use `REMEDIATION_ACTIONS_INVENTORY` to get the list of all available actions in Aternity. The inventory is valid for the day you send the REST API query. This allows you to know what remediation actions are available for using from external systems (for example, ServiceNow).

```APIDOC
## GET /REMEDIATION_ACTIONS_INVENTORY

### Description
Use `REMEDIATION_ACTIONS_INVENTORY` to get the list of all available actions in Aternity. The inventory is valid for the day you send the REST API query. This allows you to know what remediation actions are available for using from external systems (for example, ServiceNow).

### Method
GET

### Endpoint
/REMEDIATION_ACTIONS_INVENTORY

### Parameters
#### Query Parameters
- **date** (string) - Optional - Specifies the date to retrieve the inventory for.  Format: YYYY-MM-DD. Defaults to the current date.

### Response
#### Success Response (200)
- **actions** (array) - List of available remediation actions.

#### Response Example
```json
{
  "actions": [
    {
      "action_id": "123",
      "action_name": "Restart Service",
      "description": "Restarts a specified service."
    }
  ]
}
```
```
Tokens:
Raw