Current version
v7.1.1
Action Pack · Automic V24+
Full Guide · Action Pack

Automation CLI Action Pack — install, configure & operate

Full Guide for the Automation CLI Action Pack — the complete reference to install, configure and operate all 51 actions of the Automation CLI Action Pack on Automic Automation V24 and higher.

Version
7.1.1
Compatible with
Automic V24+
Actions
51 prebuilt
Execution
Interactive / batch
Contents
  1. Technical scope & concept
  2. Installation — install, update & uninstall
  3. Configuration — connection parameters reference
  4. Actions — all 51 actions, grouped by category
  5. Upgrade & migration
  6. Release notes
  7. FAQ
1 · Technical scope

Concept & technical scope

The Automation CLI Action Pack is a dedicated toolkit for managing and monitoring Broadcom Automic Automation systems at the command line. It bundles 51 ready-to-use actions for object operations, folder structures, task control, scheduling, system analysis and transports. The Automation CLI Action Pack runs both interactively and in batch mode, making it equally suited for daily administration tasks and unattended automation routines.

What an Action Pack is

Action Packs are prebuilt integration modules used in automation platforms such as Automic Automation. They simplify the integration and automation of third-party applications and services by providing a collection of reusable actions. The Automation CLI Action Pack follows the same model: every routine command-line operation against Automic is wrapped as a configurable, reusable action that can be plugged into any workflow.

Main components & functions

The Automation CLI Action Pack covers three functional areas:

Objects

  • Create, delete, mass-modify
  • Import and export between environments
  • Combine (merge calendars, schedules, agentgroups)
  • Convert and transform via change scripts
  • Read and create folder structures
  • Execute objects in bulk

Tasks

  • Monitor running and historical tasks
  • Modify state, deactivate, change status codes
  • Analyse via task and message history
  • Read, toggle and remove tasks, including periodic tasks

System

  • Analyse system status and configuration
  • Determine references, dependencies and object usage
  • Manage transports and clear transport cases
  • Read and set agent authorizations

Access & permissions

To use the Automation CLI Action Pack, the following access is required:

  • An Automic user with broad rights, sufficient to execute the relevant actions in the target client of the system. Actions that touch system-wide objects (for example transport actions or tenant-wide analyses) require correspondingly elevated rights.
  • A valid license key for the Automation CLI Action Pack, provided by Tricise. Time-limited test keys are available on request.

Requirements & compatibility

Automic Automation

  • Minimum version: Automic Automation V24
  • Reachable JCP endpoint (host and port) for the target client
  • Trusted certificate for TLS communication

Java Runtime Environment (JRE)

  • Minimum version: Java 11 (JRE or JDK)
  • Available on the agent that will execute the Automation CLI Action Pack actions
  • Either available via the PATH environment variable or as a fully qualified path (for example C:\Program Files\Java\jdk-17\bin)

ITPA Shared Action Pack

  • The Automation CLI Action Pack depends on the PCK.ITPA_SHARED Action Pack and should be installed first if not already present

2 · Installation

Installation

The Automation CLI Action Pack is installed via the standard Automic Action Pack mechanism. It can be installed in any client of the Automic Automation system except client 0. The same procedure is used for both initial installation and updates to a newer version.

Install or update

STEP 1
Log in to the target client
Log in to any client of the Automic system except client 0. The Automation CLI Action Pack will be installed in this client.
STEP 2
Open Administration view
Click on the Administration view in the Automation Web Interface (AWI).
STEP 3
Open Packs menu
Click on the Packs menu item. The list of installed Action Packs is shown.
STEP 4
Optional — install ITPA Shared dependency
If not yet present, install the dependent Action Pack PCK.ITPA_SHARED first. The Automation CLI Action Pack depends on it.
STEP 5
Install From File
Click the Install From File button.
STEP 6
Select the Action Pack ZIP
Choose the Automation CLI Action Pack ZIP file delivered by Tricise and confirm with Install.
STEP 7
Confirm update (if applicable)
If a previous version is already installed, confirm the update by clicking Install again.
STEP 8
Finish
Confirm the successful installation by clicking Close. The Automation CLI Action Pack is now installed in the client and located inside the PACKAGES folder.
Important. Do not rename the installed Automation CLI Action Pack and do not move or delete it from the PACKAGES folder. Doing so will break the action references and require a fresh install.

Uninstall

To remove the Automation CLI Action Pack from a client, follow these steps:

STEP 1
Log in to the client
Log in to the client where the Automation CLI Action Pack should be uninstalled.
STEP 2
Open Administration → Packs
Click on the Administration view, then on the Packs menu item.
STEP 3
Remove the Action Pack
Select the Automation CLI Action Pack from the list and click Remove. Confirm the removal by clicking Yes, then Close.

3 · Configuration

Configuration reference

After installation, the Automation CLI Action Pack requires a connection configuration to an existing Automic system and one of its clients. The configuration is created by running the action CONFIGURATION_ADD from the AWI. Multiple configurations can be created in parallel — one per Automic system / client combination.

Setup workflow

STEP 1
Run CONFIGURATION_ADD
Start the action CONFIGURATION_ADD from the installed Automation CLI Action Pack folder.
STEP 2
Fill the required fields

Provide the connection details (see the parameter reference below). The naming convention SYSTEMNAME_CLIENT is recommended (for example AUTOMIC_0100).

STEP 3
Submit
Confirm with Submit. The configuration is stored and immediately available for all other actions of the Automation CLI Action Pack.
STEP 4
Manage existing configurations

Use CONFIGURATION_UPDATE to change an existing configuration, and CONFIGURATION_REMOVE to delete one. New configurations can always be added by running CONFIGURATION_ADD again.

Connection parameters

Required parameters of the CONFIGURATION_ADD / UPDATE action:

ParameterDescription
Configuration Name Free-text name for the connection. Recommended syntax: SYSTEMNAME_CLIENT, for example AUTOMIC_0100.
Java Executable Java (JRE or JDK) installation used by the executing agent. java is sufficient if Java is on the PATH; otherwise provide the full path (for example C:\Program Files\Java\jdk-17\bin). Minimum version: Java 11.
Host Hostname or FQDN of the Automic system with running JCPs (for example myserver.com).
Port Port of the JCP on the Automic system (for example 8443).
Client Target client of the Automic system (for example 0100).
User Name Automic user name (for example UC).
Department Department of the Automic user (for example UC).
Password Password of the Automic user. CONFIGURATION_ADD and CONFIGURATION_UPDATE encrypt it automatically; when you update a configuration, enter the password again.
Key License key for the Automation CLI Action Pack, provided by Tricise. Time-limited test keys are available on request.

Optional parameters

ParameterDescription
Logging Path pattern for log files, for example ./log/AUT_CLI_log_##.txt.
Log Count Maximum number of log files for log rotation.
Tracing Path pattern for trace files, for example ./log/AUT_CLI_trc_##.txt.
Trace Count Maximum number of trace files for trace rotation.
CP List Alternative communication process list in addition to Host/Port (for example myserver.com:8444).
LogToStdOut Print log output to the command line. Set to 1 to enable.
Debug Enable debug mode. Set to 1 to enable. With debug mode off (0), the configuration is not written to the job report.
TrustedCertFolder Folder containing trusted certificates of the executing agent (for example C:\temp\myCerts).
Password security. The password entered in CONFIGURATION_ADD or CONFIGURATION_UPDATE is encrypted automatically. Version 4.0.0 introduced a new encryption method that is not compatible with older releases, so passwords stored with an earlier version have to be entered again. The ENCRYPT action remains available for encrypting values yourself.

4 · Actions

Actions reference

The Automation CLI Action Pack ships with 51 actions, grouped here by functional category. Every action has a fully qualified Automic object name following the pattern PCK.TRICISE_AUT_CLI.PUB.ACTION.<NAME>. All actions can be run interactively from the AWI or unattended in batch mode as part of a workflow.

Configuration management

Manage connection configurations of the Automation CLI Action Pack itself.

ActionObject nameDescription
Configuration Add / Update CONFIGURATION_ADD
CONFIGURATION_UPDATE
Create or update a connection configuration to a specific Automic system and client. The password is encrypted automatically.
Configuration Remove CONFIGURATION_REMOVE Remove an existing connection configuration.
Encrypt ENCRYPT Encrypt passwords using the same technique as Automic PromptSet masked fields, for safe storage in the configuration.
Generic Command GENERICCOMMAND Execute any internal Automation CLI Action Pack module directly via command-line syntax. Useful for power users who already know the parameters and want to skip the PromptSet UI.

Object operations

Create, modify, delete, move, execute and analyse Automic objects and folder structures from the command line.

ActionObject nameDescription
Agentgroups Create AGENTGROUPSCREATE Bulk-create agent group objects from a structured input file.
Agentgroups Read AGENTGROUPSREAD Export the definition of existing agent groups to a structured output file (compatible with Agentgroups Create).
Folder Structure Create FOLDERSTRUCTURECREATE Create a folder structure from a structured input file, for example to prepare a new client.
Folder Structure Read FOLDERSTRUCTUREREAD Export the folder structure of a client to a structured output file (compatible with Folder Structure Create).
Logins Create LOGINSCREATE Bulk-create login objects from a structured input file. Existing passwords are cleared on replace.
Logins Read LOGINSREAD Export the definition of existing login objects to a structured output file (compatible with Logins Create).
Objects Add Filter OBJECTSADDFILTER Append filter objects to existing objects based on a structured input file. New filters are appended to the end of the filter list.
Objects Add Script OBJECTSADDSCRIPT Add or insert script content into existing objects, based on a script file and target objects.
Objects Add Value OBJECTSADDVALUE Add values to variable objects (VARA) from an input file.
Objects Delete OBJECTSDELETE Delete objects based on a structured input source (file, folder, single object or VARA list), with include / exclude filters.
Objects Execute OBJECTSEXECUTE Execute objects in bulk, for example a list of jobs or workflows in one run.
Objects Link Delete OBJECTSLINKDELETE Remove object links / references between objects.
Objects Move OBJECTSMOVE Move objects between Automic folders, with input source selection and filters.
Objects Relations OBJECTSRELATIONS Determine and export the relations / dependencies of objects.
Objects Remove Filter OBJECTSREMOVEFILTER Remove filter objects from existing objects based on a structured input file.
Objects Remove Script OBJECTSREMOVESCRIPT Remove script content from existing objects.
Objects Remove Value OBJECTSREMOVEVALUE Remove values from variable objects (VARA) based on an input file.
Objects Replace OBJECTSREPLACE Replace string content within existing objects based on search-and-replace rules.
Objects Replace Attribute OBJECTSREPLACEATTRIBUTE Replace specific attribute values across multiple objects in one batch.
Objects Usage OBJECTSUSAGE Analyse the client at object level — usage status and statistics counts. The result is written to a file (since version 6.9.0; earlier versions used a VARA object). Ideal input for cleanup campaigns.

Import, export & transport

Move objects between environments, transform exports, and manage Automic transport cases.

ActionObject nameDescription
Objects Export OBJECTSEXPORT Export objects from the Automic system to a target folder. Source can be FILE, FOLDER, OBJECT or VARA, with include / exclude filters, recursive option, modify-date filter, and configurable thread count (10–20 threads recommended).
Objects Import OBJECTSIMPORT Import objects from a previously exported folder structure. Supports recursive import, replace-on-conflict, exclude filters, and configurable thread count.
Export Change EXPORTCHANGE Modify exported XML objects using the same script-file syntax as the Automic Change utility. Useful for environment-specific rewrites before re-importing.
Objects Transport OBJECTSTRANSPORT Set the transport flag on objects in bulk, based on FILE / FOLDER / OBJECT / VARA input with include and exclude filters.
Transport Clear TRANSPORTCLEAR Clear the transport case of the client referenced by the active connection. Takes no parameters.

Calendars & schedules

Merge and reset calendar and schedule objects.

ActionObject nameDescription
Calendar Merge CALENDARMERGE Merge two calendar objects into a new third calendar object, with optional replace.
Schedule Merge SCHEDULEMERGE Merge two schedule objects into a new third schedule object, with optional replace.
Schedule Reset SCHEDULERESET Reset entries of active schedule objects within a time window. Particularly useful during long maintenance windows when individual tasks must be re-run after the system comes back up. Use -ALL- to reset all schedules.

Task control

Read, monitor, modify, toggle, deactivate and remove tasks — including periodic tasks — from the command line.

ActionObject nameDescription
Tasks Monitoring TASKSMONITORING List tasks in the Automic system filtered by name, type, status code or top run number. Suitable for scripted monitoring and dashboards.
Tasks Modify State TASKSMODIFYSTATE Change the status code of tasks (any valid Automic state, for example 1900 = ENDED_OK) with optional automatic deactivation after the change.
Tasks Deactivate TASKSDEACTIVATE Deactivate tasks in bulk, filtered by name, type, agent or queue.
Tasks Read TASKSREAD Read tasks with the unified TASKS* filters, for example to check what a filter selects before running another task action.
Tasks Toggle TASKSTOGGLE Toggle the state of tasks in bulk, selected with the unified TASKS* filters.
Tasks Remove TASKSREMOVE Remove tasks in bulk, selected with the unified TASKS* filters.
Tasks Periodic Read TASKSPERIODICREAD Read the periodic tasks of the client.
Tasks Periodic Execute TASKSPERIODICEXECUTE Start periodic tasks in bulk, for example from a list created with Tasks Periodic Read.

Workflow editing

Programmatic workflow modification — add, remove, close and adjust tasks within workflows.

ActionObject nameDescription
Workflow Add Task WORKFLOWADDTASK Add a task to an existing workflow, with positioning and dependency configuration.
Workflow Remove Task WORKFLOWREMOVETASK Remove a task from an existing workflow.
Workflow Close Tasks WORKFLOWCLOSETASKS Close tasks within workflows in bulk.
Workflow Task Active WORKFLOWTASKACTIVE Set the Active flag of workflow tasks.
Workflow Task Earliest WORKFLOWTASKEARLIEST Set the Earliest start time on workflow tasks.

System & security

System status, info, message history, user authorization checks and agent authorizations.

ActionObject nameDescription
Agent Authorizations Read AGENTAUTHORIZATIONSREAD Read the client authorizations of agent objects.
Agent Authorizations Set AGENTAUTHORIZATIONSSET Set the client authorizations of agent objects in bulk.
SystemInfo SYSTEMINFO Test the connection to the configured system and output basic system information. Best used as a connectivity check before running other actions. Takes no parameters.
System Status SYSTEMSTATUS Set the client status to GO or STOP — useful for controlled maintenance windows.
Message History MESSAGEHISTORY Read system messages with filters for user, admin/security flag, message type (ALL / ERROR / INFORMATION / FAILED / SUCCESS / WARNING), category, date range and max results. Output is rendered into the job report.
User Authorizations Check USERAUTHORIZATIONSCHECK Check all users in the client for SUPERUSER rights. Takes no parameters. Useful for periodic security audits.

5 · Upgrade & migration

Upgrade & migration

Automation CLI Action Pack upgrades use the exact same procedure as the initial installation: Administration → Packs → Install From File, select the new ZIP, confirm with Install. The Automic Action Pack mechanism handles version replacement automatically.

Before upgrading

  • Make sure the dependent PCK.ITPA_SHARED Action Pack is at a version compatible with the new Automation CLI Action Pack release
  • Take a snapshot or backup of the current installation if your environment requires audit traces
  • Pause any scheduled workflows that consume Automation CLI Action Pack actions, to avoid mid-run version changes

After upgrading

  • Existing connection configurations remain valid. Exception: when upgrading from a version before 4.0.0, enter the passwords again with CONFIGURATION_UPDATE, because the encryption method changed.
  • Run the SYSTEMINFO action against each configured connection as a smoke test
  • Resume any paused workflows

Version-specific notes

  • Version 6.9.0: OBJECTSUSAGE writes its result to a file instead of a VARA object. Adapt follow-up steps that read the VARA.
  • Version 5.0.0: several actions were renamed. The *TOFILE and *FROMFILE actions lost their suffix, ANALYSEUSAGE became OBJECTSUSAGE, READHOSTGROUPTOFILE and CREATEHOSTGROUPFROMFILE became AGENTGROUPSREAD and AGENTGROUPSCREATE, READLOGINTOFILE and CREATELOGINFROMFILE became LOGINSREAD and LOGINSCREATE, and MERGESCHEDULE and RESETSCHEDULE became SCHEDULEMERGE and SCHEDULERESET. OBJECTSCREATE and OBJECTSRENAME were removed. Workflows that call the old names have to be adapted.
  • Version 5.0.0: the MODE parameter of AGENTGROUPSREAD and AGENTGROUPSCREATE takes ANY, LOAD, ALL, NEXT or FIRST instead of single letters.
  • Version 3.7.2: the Action Pack was renamed to PCK.TRICISE_AUT_CLI; the object names of older installations change accordingly.
Tip. Use a non-production client to validate a new release of the Automation CLI Action Pack first, especially if the version jump introduces new actions or parameter changes.

6 · Release notes

Release notes

All versions of the Automation CLI Action Pack and what changed in each. Versions before 3.0.0 were released under the name AEAPI.

v7.1.1 (current) · 2026-10-06

VersionTypeChange
7.1.1
2026-10-06
Fixed Workflow Add Task: column shift corrected
Changed User group modules: deprecated fields removed

Earlier versions

Versions 6.0.0 – 7.1.0 (2025–2026)
VersionTypeChange
7.1.0
2026-05-20
Fixed Bug fixes and refactoring of the code base
7.0.0
2025-12-04
Changed Licence handling adjusted; a valid licence key is required
6.9.0
2025-12-04
Changed OBJECTSUSAGE writes its output to a file instead of a VARA object
6.8.0
2025-11-19
New Action TASKSTOGGLE
6.7.0
2025-11-19
Changed Unified filters for all TASKS* actions
6.6.0
2025-11-15
New Action TASKSREAD
6.5.0
2025-11-14
New Action OBJECTSEXECUTE
6.4.0
2025-11-13
New Actions TASKSPERIODICREAD and TASKSPERIODICEXECUTE
6.3.0
2025-10-29
New Actions AGENTAUTHORIZATIONSREAD and AGENTAUTHORIZATIONSSET
Fixed The configuration is no longer shown in the job report when debug mode is off
6.2.0
2025-10-13
Changed Licence handling adjusted
6.1.0
2025-06-13
New Actions FOLDERSTRUCTUREREAD and FOLDERSTRUCTURECREATE
6.0.1
2025-06-12
Fixed OBJECTSMOVE: error in the process method
Fixed OBJECTSLINKDELETE: wrong include name
6.0.0
2025-02-11
Changed CONFIGURATION_ADD, CONFIGURATION_REMOVE and CONFIGURATION_UPDATE: “connection” renamed to “configuration”
Versions 4.0.0 – 5.1.2 (2024–2025)
VersionTypeChange
5.1.2
2025-01-10
Changed Validity check supports Automic SaaS names ($@@$)
5.1.1
2024-11-11
Fixed EXPORTCHANGE can change attributes of JSCH tasks
5.1.0
2024-11-11
New Actions WORKFLOWREMOVETASK and TASKSREMOVE
5.0.0
2024-11-07
Changed Clean-up and partial renaming of the actions
Removed Actions OBJECTSCREATE and OBJECTSRENAME
Changed *TOFILE and *FROMFILE actions renamed without the suffix
Changed ANALYSEUSAGE renamed to OBJECTSUSAGE
Changed READHOSTGROUPTOFILE and CREATEHOSTGROUPFROMFILE renamed to AGENTGROUPSREAD and AGENTGROUPSCREATE
Changed READLOGINTOFILE and CREATELOGINFROMFILE renamed to LOGINSREAD and LOGINSCREATE
Changed MERGESCHEDULE and RESETSCHEDULE renamed to SCHEDULEMERGE and SCHEDULERESET
Changed REMOVELINKSFROMFOLDER renamed to OBJECTSLINKDELETE
Changed AGENTGROUPSREAD and AGENTGROUPSCREATE: MODE takes ANY, LOAD, ALL, NEXT or FIRST instead of single letters
Changed CALENDARMERGE and SCHEDULEMERGE: new Replace parameter
Fixed OBJECTSRELATIONS: transport mode works again
4.2.1
2024-11-05
Fixed CONFIGURATION_UPDATE: variable CONFIG_NAME removed
4.1.0
2024-09-12
New Action to update an existing configuration (the password has to be entered again)
4.0.0
2024-09-09
Changed ENCRYPT: new encryption method, not compatible with the previous one
Changed Adding a configuration encrypts the password field automatically
Versions 3.0.0 – 3.9.0
VersionTypeChange
3.9.0
2024-09-06
Changed JAVACMD variable: all actions, CONFIGURATION_ADD and ENCRYPT can run with a self-defined Java executable
3.8.0
2024-05-24
Changed commons.io removed from the libraries; EXPORTCHANGE uses Java defaults instead
3.7.2
2024-02-29
Changed Action Pack renamed to PCK.TRICISE_AUT_CLI
3.7.1
2023-12-01
Fixed EXPORTCHANGE: titles with an asterisk were processed twice
3.7.0
2023-09-19
Changed ANALYSEUSAGE: new input parameters OBJECT, FILE, FOLDER and VARA
New Action OBJECTSRENAME (prefix and suffix, no replacement of references)
3.6.3
2023-06-16
Changed WORKFLOWADDTASK: new optional parameters format, removeredundancies and closetasks
3.6.2
2023-06-16
Removed Action MOVEFROMFOLDER, replaced by OBJECTSMOVE
3.6.1
2023-06-15
New Action OBJECTSMOVE
Fixed Objects Delete: parameter deletesource
3.6.0
2023-06-14
New Actions WORKFLOWTASKACTIVE, WORKFLOWTASKEARLIEST and GENERICCOMMAND
3.5.3
2023-03-29
Changed Tasks Deactivate uses the API filter instead of regular expressions
3.5.2
2023-02-23
Fixed Objects Create can create folders only
3.5.1
2023-02-21
Fixed Links are added to ACTIONS/CUSTOM instead of ACTIONS/CAPTURE, because an export deleted them
3.5.0
2023-02-16
Changed New build concept with aut_cli.jar and aut_cli_base.jar
3.4.1
2023-02-16
Changed Action Pack renamed to PCK.CAPTURE_AUT_CLI
3.4.0 New Action TASKSMONITORING
3.3.0 New Actions USERSETTITLE (no longer part of the pack) and USERCHECKAUTHORIZATIONS (today USERAUTHORIZATIONSCHECK)
3.2.2 Fixed Schedule Reset: the start time must be greater than or equal to the window start
3.2.1 Fixed Folder tree cache: change in the folder lookup reverted
3.2.0 Changed Objects Transport: parameters includeArchiveKey1, includeArchiveKey2 and excludeName removed, includeName added, faster transport of folders
3.1.2 Fixed Encrypt: connection field removed
3.1.1 Fixed Licence check
3.1.0 New Actions CONFIGURATION_ADD (with automatic password encryption) and CONFIGURATION_REMOVE
Changed ENCRYPT publishes the variable &AUT_CLI_ENCRYPTED_PASSWORD#
3.0.2 Changed The configuration objects are no longer overwritten by updates
3.0.1 Changed @echo off removed
3.0.0 Changed Renamed to AUT_CLI (formerly AEAPI); libraries renamed to aut_cli_base.jar and config.ini
Versions 2.1.0 – 2.4.0 (AEAPI)
VersionTypeChange
2.4.0 Changed Library hardened (obfuscated) and renamed to AutomicTools.jar
2.3.1 Changed Objects Remove Script: parameters 4 and 5 optional, otherwise the whole script is removed
Changed PromptSet date fields default to 01/01/2000
Changed Date variables use YYYY-MM-DD instead of YYMMDD
2.3.0 Fixed The actions fail correctly if the licence is not valid
Changed Key entries removed from the configuration file
2.2.0 Changed Library cleaned up
New Message History
2.1.1 Changed Objects Create: new fields jobp.queue and jobp.children_queue; script, prescript and postscript with <br>
2.1.0 New CP list entry in the configuration file (initial login only, no CP rotation)

7 · FAQ

Frequently asked questions

Click any question to expand the answer.

What is the Automation CLI Action Pack and what does it do?

The Automation CLI Action Pack is a dedicated Tricise toolkit for managing and monitoring Automic Automation systems at the command line. It bundles 51 ready-to-use actions covering object operations (create, delete, modify, execute, import, export, replace, transport), folder structures, task control, calendar and schedule management, system analysis, workflow editing, and security checks. Every routine command-line operation against Automic is wrapped as a configurable, reusable action that can be plugged into any workflow.

The Automation CLI Action Pack runs both interactively from the AWI and unattended in batch mode, making it equally suited for daily administration and automated routines.

Which Automic versions are supported?

The Automation CLI Action Pack requires Automic Automation V24 or higher. The connection uses the standard Automic Java API over a JCP endpoint with TLS-secured communication. You need a reachable JCP host and port for the target client, and a trusted certificate for the TLS connection.

What are the technical requirements?

The Automation CLI Action Pack runs as part of an Automic Action Pack installation, so the requirements are:

  • Automic Automation V24+ with reachable JCP endpoint
  • Java 11 or higher (JRE or JDK) on the executing agent
  • The dependent Action Pack PCK.ITPA_SHARED installed in the same client
  • An Automic user with sufficient rights for the actions you intend to run
  • A valid Automation CLI Action Pack license key from Tricise
How do I install the Automation CLI Action Pack?

Log in to any Automic client except client 0, open Administration → Packs, optionally install PCK.ITPA_SHARED first, then click Install From File and select the Automation CLI Action Pack ZIP delivered by Tricise. The installer is the same for new installs and updates — just point it at the new ZIP. After install, the Action Pack lives inside the PACKAGES folder. Do not rename or move it.

How is the connection to Automic configured?

Run the action CONFIGURATION_ADD from the installed Automation CLI Action Pack folder and fill in the required fields: configuration name (recommended pattern: SYSTEMNAME_CLIENT), Java executable path, host, port, client, user name, department, password, and the Tricise license key. Multiple connection configurations can be created in parallel — one per Automic system / client combination. Use CONFIGURATION_UPDATE to change one and CONFIGURATION_REMOVE to delete one.

How are passwords stored in the configuration?

Passwords entered in CONFIGURATION_ADD or CONFIGURATION_UPDATE are encrypted automatically before they are stored in the configuration. Since version 4.0.0 the Automation CLI Action Pack uses an encryption method that is not compatible with earlier versions; after upgrading from an older release, enter the passwords again with CONFIGURATION_UPDATE. The dedicated ENCRYPT action is still available to encrypt values yourself.

How do I move objects between environments?

Use the OBJECTSEXPORT action to export objects from the source environment, and OBJECTSIMPORT on the target environment to import them. Both actions support input by FILE, FOLDER, OBJECT or VARA list, with include / exclude filters, recursive folder support, modify-date filtering and configurable thread counts (10–20 threads recommended for performance, but watch the load on the source Automic system).

If you need to rewrite values during the move (host renames, environment-specific paths), use EXPORTCHANGE on the exported XML files before importing — it uses the same script-file syntax as the Automic Change utility.

Can the Automation CLI Action Pack run unattended in batch mode?

Yes. Every action of the Automation CLI Action Pack can be executed both interactively from the AWI and unattended as part of a workflow. For batch use, parameter values are normally provided through the action’s PromptSet, through workflow variables, or — if you already know the underlying module syntax — directly via the GENERICCOMMAND action which lets you pass a raw command line.

How do I clean up unused or obsolete objects safely?

The recommended workflow is two-step. First run OBJECTSUSAGE against the target folder or object list — it analyses each object for usage status and statistics counts and writes the result to a file (since version 6.9.0; earlier versions wrote it to a Variable object). Review the result to confirm which objects are truly safe to remove. Then pass the confirmed list to OBJECTSDELETE, which accepts a file as input source, to remove the objects in a controlled, repeatable batch.

How do I perform mass changes during export?

Use the EXPORTCHANGE action of the Automation CLI Action Pack. It modifies exported XML objects using the same script-file syntax as the Automic Change utility — point it at the export folder and a change-file with your rules, and optionally enable recursive processing for subfolders. Perfect for host renames, path rewrites and other environment-specific transformations between DEV, TEST and PROD.

How do I bulk-deactivate or modify task states?

Use TASKSDEACTIVATE for bulk deactivation, filtered by task name, type, agent or queue. To change task status codes (for example to force a task into 1900 = ENDED_OK), use TASKSMODIFYSTATE — it accepts any valid Automic state code and offers an optional auto-deactivate after the state change. For listing and monitoring without modification, use TASKSMONITORING.

To remove tasks, use TASKSREMOVE; to switch their state in bulk, use TASKSTOGGLE. Since version 6.7.0 all TASKS* actions share the same filter options.

How do I check if any users in a client have SUPERUSER rights?

Run the USERAUTHORIZATIONSCHECK action of the Automation CLI Action Pack. It scans every user in the configured client and lists the ones with SUPERUSER rights. The action takes no parameters and is ideal as a scheduled security audit.

Can I read system messages with filters?

Yes. The MESSAGEHISTORY action reads system messages with rich filter options: user name, admin / security message flags, message type (ALL, ERROR, INFORMATION, FAILED, SUCCESS, WARNING), category (ALL, ACCESS TO HOST, LOGIN, MESSAGE, OBJECT_ACCESS, PRIVILEGE), from / to date (YYYY-MM-DD format) and a max results limit. The matched messages are rendered into the job report of the Automic Windows or Unix job that runs the action.

How is the Automation CLI Action Pack licensed?

The Automation CLI Action Pack is licensed as a one-time purchase per Automic system — no recurring subscription, no expiry. The fixed price is published in the Tricise shop. The license includes Tricise product support and compatibility updates for the current Automic V24+ release line. Time-limited evaluation license keys are available on request for proof-of-concept work.

Need help with the Automation CLI Action Pack?
Talk to our experts about installation, integration, training, or licensing.
Scroll to Top