Current version
v3.5.2
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 40 actions of the Automation CLI Action Pack on Automic Automation V24 and higher.

Version
3.5.2
Compatible with
Automic V24+
Actions
40 prebuilt
Execution
Interactive / batch
Contents
  1. Technical scope & concept
  2. Installation — install, update & uninstall
  3. Configuration — connection parameters reference
  4. Actions — all 40 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 40 ready-to-use actions for object operations, 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

Tasks

  • Monitor running and historical tasks
  • Modify state, deactivate, change status codes
  • Analyse via task and message history

System

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

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. Can be encrypted via the ENCRYPT action.
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.
TrustedCertFolder Folder containing trusted certificates of the executing agent (for example C:\temp\myCerts).
Password security. Use the dedicated ENCRYPT action of the Automation CLI Action Pack to encrypt sensitive passwords before storing them in the configuration. The encryption uses the same technique as masked password fields in Automic PromptSets.

4 · Actions

Actions reference

The Automation CLI Action Pack ships with 40 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.
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 and analyse Automic objects 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).
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 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. Results are stored in a VARA object for further processing. 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

Monitor, modify and deactivate 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.

Workflow editing

Programmatic workflow modification — add, 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 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 and authorization checks.

ActionObject nameDescription
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 — no need to re-enter passwords or license keys
  • Run the SYSTEMINFO action against each configured connection as a smoke test
  • Resume any paused workflows
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

Recent Automation CLI Action Pack versions and what changed in each.

v3.5.2 (current)

TypeDescription
CompatibilityCertified for Automic Automation V24
EnhancementPerformance improvements for Objects Export and Objects Import on large object trees
BugfixVarious stability and edge-case fixes

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 40 ready-to-use actions covering object operations (create, delete, modify, import, export, replace, transport), 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?

The Automation CLI Action Pack ships with a dedicated ENCRYPT action that encrypts passwords using the same technique as masked password fields in Automic PromptSets. The encrypted value can then be safely stored in the connection configuration. Plain-text passwords are technically possible for quick tests but should never be used in production.

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 VARA list — it analyses each object for usage status and statistics counts and writes the result into a Variable object you specify. Review the VARA contents to confirm which objects are truly safe to remove. Then feed the cleaned VARA list into OBJECTSDELETE to remove them 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.

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 (YYMMDD 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