CLI Commands#
The following list shows the commands that are available.
Note: CLI commands do not support new lines. Entries are broken for display purposes only.
Most of these commands have equivalent commands in the REST API. See REST commands for the HCL Launch server.
- addAgentPoolToTeam
Add an agent pool to a team - addAgentToPool
Add an agent to an agent pool - addAgentToTeam
Add an agent to a team - addApplicationToTeam
Add an application to a team - addComponentTemplateToTeam
Add a component template to a team - addComponentToApplication
Add a component to an application. - addComponentToTeam
Add a component to a team - addEnvironmentBaseResource
Add a base resource to an environment - addEnvironmentProperty
Create a component environment property - addEnvironmentToTeam
Add an environment to a team - addJavaPackage
Upload a Java package. - addProcessToTeam
Add a process to a team - addResourceToTeam
Add a resource to a team - addStatusToSnapshot
Add a status to a snapshot - addTagToAgent
Add a tag to an agent - addTagToApplication
Add a tag to an application - addTagToComponent
Add a tag to a component - addTagToResource
Add a tag to a resource - addUserToGroup
Add a user to a group - addUserToTeam
Add a user to a role on a team - addVersionFiles
Upload files to a version - addVersionLink
Add a link on a version - addVersionLinkWithName
Add a link on a version - addVersionStatus
Add a status to a version - addVersionToSnapshot
Add a component version to a snapshot - addWebhookToApplication
Add a webhook to an application - addWebhookToProcess
Add a webhook to a process - archiveVersion
Archive the given versions of a component -
cancelWorkflow
Cancel a workflow in progress - closeTask
Approve or reject an approval task - copyResource
Copy a resource into a new parent - copyVersion
Copy a component version with all of its properties - createAgentPool
Create an agent pool - createApplication
Create an application from a JSON file - createApplicationFromTemplate
Create an application with components from a JSON file - createApplicationProcess
Create an application process - createApplicationTemplate
Create an application template from a JSON file - createAuthToken
Create an authorization token - createComponent
Create a component - createComponentProcess
Create a new component process - createComponentTemplate
Create a component template from a JSON file - createDeploymentTrigger
Create a deployment trigger. - createEnvironment
Create a new environment - createEnvironmentFromTemplate
Create a new environment from template - createEnvironmentTemplate
Create a new environment template - createGenericProcess
Create a generic process - createGroup
Create an empty group - createManyVersions
Create multiple component versions - createResource
Create a resource - createResourceTemplate
Create a resource template from a JSON file - createResourceTemplateWithAgentPrototypes
Create a resource template with agent prototypes from a JSON file - createSnapshot
Create a snapshot - createSnapshotOfEnvironment
Take a snapshot of an environment - createStatus
Create a status - createTeam
Create a team - createUser
Create a user - createVersion
Create a component version - createWebhookTemplate
Create a new webhook template - deleteAgent
Delete an agent - deleteAgentPool
Delete an agent pool - deleteAgentProperty
Remove a property from an agent - deleteAllDesiredInventoryVersions
Delete all versions for a component in an environment - deleteApplication
Delete an application -
deleteApplicationTemplate
Delete an application template - deleteBlueprintDesignerIntegration
Delete a blueprint designer integration - deleteComponent
Delete a component - deleteComponentVersionPropDef
Delete a component version property - deleteDeploymentTrigger
Delete a deployment trigger. - deleteEnvironment
Delete an environment - deleteEnvironmentTemplate
Delete an environment template - deleteFrontendServer
Delete a frontend server. - deleteGroup
Delete a group - deleteJavaPackage
Delete a java package. - deleteRedundantDesiredInventoryVersions
Delete all redundant versions for a component in an environment - deleteResource
Delete a resource - deleteResourceProperty
Delete a resource property - deleteSnapshot
Delete a snapshot - deleteStatus
Delete a status - deleteTeam
Delete a team - deleteUser
Delete a user - deleteVersion
Delete a version from a component - deleteWebhookTemplate
Delete a webhook template - downloadVersionArtifacts
Download the artifacts of a component version - exportApplication
Export an application to a json file. - exportComponent
Export a component to a json file. - exportComponentTemplate
Export a component template to a json file. - exportDetailedGroup
List the members of a group (detailed) - exportGenericProcess
Export a process to a json file - exportGroup
List the members of a group - exportSnapshot
Export a snapshot to a zip file. - finishedImporting
Mark a version as completed importing - forceRenameAgent
Rename an agent - getAgent
Get information about an agent -
getAgentPool
Get information about an agent pool - getAgentPools
Get information about all agent pools - getAgentProperty
Get the value of a property on an agent - getAgentPrototypes
Get all agent prototypes with this resource template as their ancestor - getAgentStatuses
Returns a JSONObject with count of agents to status. Expected format: { "ONLINE":4, "UPGRADE_RECOMMENDED":1 } Requires Settings Tab permission - getAgents
Get information about all agents - getAllApplicationProcessesForApplication
Get all application processes of an application - getAllComponentProcessRequestCount
Get all component process requests submitted after a certain time - getAllComponentsForTemplate
Get a list of all components using this template - getAllLatestDesiredInventory
Get all of the latest desired inventory for an environment. - getAllProcesses
Get information on all generic processes - getAllTeams
List teams - getAllUsersInRoleForTeam
List all users with a given role on a team - getAllUsersWithEmail
Get all users with a given e-mail address - getApplication
Get information about an application - getApplicationProcess
Get information about an application process - getApplicationProcessExecution
Get an application process request's activity trace. - getApplicationProcessRequest
Get information about a specific application process request -
getApplicationProcessRequestStatus
Request the status of an application process request - getApplicationProcessUnfilledProperties
List properties that must be specified for a process - getApplicationProperties
Get all application properties and their values. - getApplicationProperty
Get the value of a custom property on a application - getApplicationTemplate
Get information about an application template - getApplicationTemplatePropDefs
Get information about the property definitions for the application template - getApplicationTemplates
Get information about all application templates on the server - getApplications
Get information about all applications on the server - getApplicationsProcessRequests
Get information about all application process requests on the server - getApplicationsProcessRequestsCount
Count all application process requests - getApprovalTasks
List recent approval tasks - getAuthenticationRealms
Get information about all authentication realms on the server - getBlueprintNodePropertiesTemplate
Get blueprint properties - getBlueprintsInApplication
Get all blueprints in an application - getComponent
Get information about a component - getComponentEnvironmentProperties
Get component environment properties for an environment - getComponentProcess
Get information about a component process - getComponentProcessRequest
Get information about a specific component process request - getComponentProcessRequestCount
Get the number of component process requests submitted after a certain time given a specified component - getComponentProcessRequests
Get information about all component process requests - getComponentProperties
Get values for component properties - getComponentProperty
Get the value of a property on a component. Property names can be prefixed to specify which set of propertieswill be searched. Unprefixed properties will search custom 'Component Properties' on a component while a propertynamed such as template/propertyName will search the properties inherited from a component templates property definitions. - getComponentTemplatePropDefs
Get information about the property definitions for the component template - getComponentTemplates
Get information about all component templates on the server - getComponentVersionPropDefs
List the version property definitions for a component - getComponentVersions
Get the versions of a component - getComponents
Get information about all components on the server - getComponentsInApplication
Get all components in an application - getCurrentActivityList
Returns all child workflows of a parent request id if specified else returns all running workflow activities. - getDeploymentTrigger
Get information about a single deployment trigger. - getDeploymentTriggers
Get information about all deployment triggers for an environment. - getEnvironment
Get information about an environment - getEnvironmentBaseResources
Get all base resources for an environment - getEnvironmentProperties
Get environment property values - getEnvironmentProperty
Get the value of a custom property on an environment. - getEnvironmentResourceTree
Get resource tree for an environment - getEnvironmentTemplate
Get information about an environment template - getEnvironmentTemplatePropDefs
Get information about the property definitions for the environment template - getEnvironmentsInApplication
Get information about all environments in an application - getFirstUserWithEmail
Get the first user with a given e-mail address - getFrontendServers
Get a list of frontend servers. - getHighWatermarks
Return high watermarks for agent usage - getInventoryChangesForSnapshot
Get inventory changes for application process run with snapshot in environment - getJavaPackage
Get available Java packages. - getJavaPackages
Get available Java packages. - getJavaPackagesForAgent
Get Java packages compatible with a specific agent. - getLatestDesiredInventory
Get the latest desired inventory for an environment. - getLatestSnapshotForEnvironment
Get the latest snapshot deployed to an environment - getOverlappingArtifacts
Get all artifacts overlapped in the given version -
getProcessRequests
Get information about all generic process requests on the server - getRelayStatuses
Returns a JSONObject with count of agent relays to status. Expected format: { "ONLINE":4, "OFFLINE":1, } Requires Settings Tab permission. - getRelays
Get information about all relays a user has access to. - getResource
Get information about a resource - getResourceInventoryEntriesForComponent
Get current resource inventory entries for a component - getResourceProperties
List resource properties - getResourceProperty
Get a resource property - getResourceTemplate
Get a resource template - getResourceTemplateChildren
Get all children or descendants of a resource template - getResources
List resources - getResourcesWithComponentVersion
List resources that have a specified component version - getSnapshot
Get information about a snapshot - getSnapshotConfiguration
Get the list of configuration objects in a snapshot - getSnapshotVersions
Get the list of versions in a snapshot - getSnapshotsInApplication
Get information about snapshots in an application - getStatus
Get information about a status - getStatusList
Get a list of statuses on a snapshot - getStatuses
List statuses - getSystemConfiguration
List system configuration properties - getSystemProperties
List system properties - getSystemProperty
Get the value of a system property - getTagsForType
Get the Tags for an object type. - getTagsOnAgent
List all tags on an agent - getTagsOnApplication
List all tags on an application - getTagsOnComponent
Return all tags on a component - getTagsOnResource
List the tags on a resource - getTasksForUser
Return all approval tasks and manual tasks assigned to the user - getTeam
List information about a team - getUser
List information about a user - getUserByEmail
Get the user or users with a given e-mail address - getUsersThatCanRunDeploymentTriggers
Get all users that can run deployment triggers. - getVersionId
Get a version ID - getVersionLink
Get a link on a component version - getVersionLinks
List links on a version - getVersionProperties
List the properties on a component version - getWebhookTemplate
Get information about a webhook template - getWebhookTemplates
List the viewable webhook templates - importApplication
Import application from json file. - importComponent
Import component from json file. - importComponentTemplate
Import component template from json file. - importGenericProcess
Import process from json file. - importGroup
Import a group - importLdapUser
Import a user from LDAP - importSnapshot
Import snapshot from zip file. - importVersions
Import new component versions - installAgent
Install an agent - installAgentJava
Install a java package as a new managed java installation - listArtifacts
Get the list of artifacts for a version - lockSnapshotConfiguration
Lock a snapshot's configuration - lockSnapshotVersions
Lock a snapshot's version list - login
Log in to the server - logout
Log out of the server - moveResource
Update a resource's parent - pauseWorkflow
Pause a workflow in progress - provisionEnvironment
Provision a cloud environment - removeAgentFromPool
Remove an agent from an agent pool - removeAgentFromTeam
Remove an agent from a team - removeAgentPoolFromTeam
Remove an agent pool from a team - removeApplicationFromTeam
Remove an application from a team - removeComponentFromTeam
Remove a component from a team - removeComponentTemplateFromTeam
Remove a component template from a team - removeEnvironmentBaseResource
Remove a base resource from an environment - removeEnvironmentFromTeam
Remove an environment from a team - removeEnvironmentProperty
Delete a component environment property - removeGroupFromRoleOnTeam
Remove a group from a role on a team - removeProcessFromTeam
Remove a process from a team - removeResourceFromTeam
Remove a resource from a team - removeTagFromAgent
Delete a tag from an agent - removeTagFromApplication
Remove a tag from an application - removeTagFromComponent
Delete a tag from a component - removeTagFromResource
Remove a tag from a resource - removeUserFromGroup
Remove a user from a group - removeUserFromRoleOnTeam
Remove a user from a role on a team - removeVersionFromSnapshot
Remove a component version from a snapshot - removeVersionLink
Remove a link from a version - removeVersionLinkByName
Remove a link from a version - removeVersionStatus
Remove a status from a version - removeWebhookFromApplication
Removes a webhook from a process - removeWebhookFromProcess
Removes a webhook from a process - repeatApplicationProcessRequest
Repeat an application process request - requestApplicationProcess
Run an application process - requestProcess
Executes new generic process request(s) for resource(s) - restartAgent
Restart an agent - resumeWorkflow
Resume a workflow in progress - setAgentJavaHome
Set the configure JAVA_HOME of an agent - setAgentProperty
Set a property on a agent - setApplicationProperty
Set a property on an application - setComponentEnvironmentProperty
Set a component environment property value - setComponentProperty
Set a property on a component - setComponentVersionPropDef
Set a version property for a component - setEnvironmentProperty
Set a property on environment - setResourceProperty
Set a property on a resource - setSystemConfiguration
Update the system configuration - setSystemProperty
Set a system property - setVersionProperty
Set a property on a component version - shutdownAgent
Shut down an agent - testAgent
Test the connection from an agent to the server - uninstallAgentJava
Uninstall managed java installation - updateAgent
Update agent settings - updateApplicationTemplate
Update an application template - updateApplicationTemplatePropDefs
Update an application template prop sheet def from a JSON file. - updateComponent
Update a component - updateComponentTemplatePropDefs
Update a component template prop-def sheet from a JSON file. Replaces the property definitions. - updateEnvironment
Update an environment - updateEnvironmentTemplate
Update the basic settings of an environment template - updateEnvironmentTemplatePropDefs
Update an environment template prop sheet def from a JSON file. - updateResource
Update a resource - updateResourceTemplate
Update a resource template from a JSON file - updateTeam
Update a team - updateUser
Update a user - updateUsersInAuthRealm
Update all users in an authentication realm - updateWebhookForApplication
Update an application webhook - updateWebhookForProcess
Updates a webhook for a process - updateWebhookTemplate
Update a webhook template - upgradeAgent
The agent will be upgraded to the agent version corresponding with the HCL Launch server version.
Parent topic: Command-line client (CLI) reference