Agent macOS 2.0 – Installation

This document provides the installation guide for Almaden agents on macOS. These agents are essential components responsible for collecting and transmitting device data to the CIQ ITAM and CIQ DEX portals. By ensuring their proper installation and configuration, organizations can guarantee accurate data flow for asset management, performance, and digital experience insights.

If there is a previous installation of the Agent, run the command below before proceeding:

sudo rm -rf /Applications/AutomatosADA

Step 1 – Download

CIQ ITAM> Settings> Agent Download

• Select Operating System: MacOS
• Click> Download

Step 2 – Run the installation package.

Step 3 – Proceed with the installation process.

You can check for the almaden-agent in “Applications”

Step 4 – Configuration commands

Applying the configuration commands is mandatory.

# Example
almacli config set --SUBCOMMAND CONFIGURATION

#Commands
almacli config set --customer-email ACCOUNT
almacli config set --department-name DEPARTMENT
almacli config set --receiver-url RECEIVER
almacli config set --receiver-port 443

ACCOUNT = Main account for accessing CIQ ITAM and CIQ DEX (Not a user sub-account)
DEPARTMENT = Department where this device’s record will be created in CIQ ITAM
almacli config set --receiver-port 443 = Do not change this line; communication occurs only through port 443

RECEIVER = Agent data transmission to Almaden
LAD1: lad1v1rm1.almaden.app
LAD2: lad2v1rm1.almaden.app

Example

Step 5 – Check the applied settings

almacli config get

Step 6 – Data Consolidation Time

Please allow up to 1 hour after installation, with the device turned on and connected to the internet, for the data to be consolidated in the CIQ ITAM and CIQ DEX portals.

DONE!

This test is crucial to validate agent communication with Almaden. Any blockage on the corporate network may prevent data from being sent, which would result in the device not being registered on the CIQ ITAM and CIQ DEX portals.

# Command to test communication with LAD1
nc -vz lad1v1rm1.almaden.app 443

# Command to test communication with LAD2
nc -vz lad2v1rm1.almaden.app 443

Advanced commands are used to analyze the agent’s behavior, stop and restart the process, and validate data transmission to the CIQ ITAM and CIQ DEX portals.

almacli

Displays the installed agent’s version.

almacli --version  

almacli config  

almacli config get  

Displays the configurations applied to the agent.

Applies the agent’s communication commands: Main Account, Department, Receiver, and Receiver Port.

• ACCOUNT = Main account
• DEPARTMENT = Department to organize the device at CIQ ITAM
• RECEIVER = Receiver address
• Note: Port 443 should never be changed

almacli config set --customer-email ACCOUNT
almacli config set --department-name DEPARTMENT
almacli config set --receiver-url RECEIVER
almacli config set --receiver-port 443

Displays the logs of each entity for both collector and consumer.

almacli entity-logs

Provides detailed logs for each entity.

almacli entity-logs --entity-name ENTITY_NAME

Example

Displays the agent’s operational flow, showing the execution date of readers, reader threads, and Dispatch.

almacli application-logs

Displays the list of all components of the entities.

almacli list SUBCOMMAND  

This command only lists the application components.

Example:

Check the agent’s operating and dispatch flow

almacli activity SUBCOMMAND  

Displays how many times the related reader has run in the last 30 days and its most recent execution.

almacli activity read-thread  

almacli activity dispatch-thread

Displays how many times data has been sent to Almaden in the last 30 days and its most recent transmission.

Commands to control the agent’s operation, including stopping and starting the agent.

# Starts the agent's operation
almacli launchd load

Stops the agent's operation.
almacli launchd unload  

Note: The agent can only be stopped using “unload”; if terminated by other methods on macOS, it will automatically restart.

Uninstall

To uninstall the Almaden agent, run the command below:

cd "/Library/Application Support/Almaden/Uninstall/" && ./almaden-agent.command

After entering the administrator password, the agent will be uninstalled.