Manage Agent Factory from the Command Line

Use the aaictl command-line utility inside the Agent Factory container to manage Agent Factory services and administrative settings.

You can run aaictl <command> from any directory inside the container. To view the available commands and options, run:

aaictl --help

Only administrators with shell access to the Agent Factory container can run these commands. Use the commands only during approved maintenance activities.

Manage Services

Use the following commands to manage all Agent Factory services.

Command	Description
aaictl restart	Stops and then starts all Agent Factory services. Use this after configuration changes so running processes reload the latest settings.
aaictl stop	Stops all Agent Factory application services and pauses related runtime jobs. Use this before maintenance, database migration, or configuration changes that require the application to be offline.
aaictl start	Starts Agent Factory services, including the web server, asynchronous server, ingestion engine, and scheduled jobs.
aaictl sso disable	Disables single sign-on (SSO). Use this to restore access when an incorrect SSO configuration prevents users from signing in.
aaictl info	Displays basic runtime information, such as the Agent Factory application URL.
aaictl status	Displays the running status of key Agent Factory components, such as the Agent Factory server and ingestion engine.
aaictl version	Displays the installed Agent Factory version and build information.

Update Application Properties

Use aaictl updateproperty to update an application property. You can update a single property or provide a properties file.

aaictl updateproperty -k <property_name> -v <value>
aaictl updateproperty -p <properties_file_path>

The properties file must use key=value entries. Valid property names are DB_HOST, DB_PORT, DB_SERVICE, DB_USER, DB_PASSWORD, WEBAPP_PORT, DB_WALLET, INSTANT_CLIENT, JAVA_HOME, CLAMSCAN, LOG_RETENTION, CLIENT_KEY_EXPIRY_IN_DAYS, and GRACE_PERIOD_IN_DAYS.

Important:

Do not use aaictl updateproperty -k DB_PASSWORD -v <value> to rotate the database user’s password. This command updates only the stored application password. Use it only as a repair or configuration synchronization step when the database password was changed externally and the application must store the same password. If the password in the database does not match, Agent Factory can lose database connectivity after it restarts.

The aaictl changedb command is not included in the 26.7 release. Do not use updateproperty as a substitute for switching to a different database schema or user.

Manage Certificates and Passwords

Use the following commands to manage certificates and passwords.

Command	Description
aaictl importcert -cert <certificate_file_path> -key <key_file_path>	Imports a browser-facing SSL/TLS certificate and its private key.
aaictl changeapplicationpassword	Resets an Agent Factory application user password. The command prompts for the user and new password, then updates the application credential store.
aaictl changedbpassword	Changes the password for the configured database user and updates the stored application password. By default, it restarts services so they use the new password.
aaictl certs add --file <certificate file>	Adds a customer-provided CA certificate to the outbound trust store, enabling secure connections to external services that use certificates signed by that CA.
aaictl certs status	Displays the list of customer-added outbound CA certificates currently configured in the outbound trust store.
aaictl certs reset --yes	Removes all customer-added outbound CA certificates from the outbound trust store and restores the default certificate configuration.

Note: Use aaictl changedbpassword when you need to rotate the configured database user’s password. It performs the database-side and application-side update together.