Jump to main content
HCL Logo Product Documentation
Customer Support Community
Customer Support HCLSoftware U Community Forums Customer Idea Portal
DevOps Loop
  1. Home icon
  2. Welcome
  3. Capabilities of DevOps Loop

    HCL DevOps Loop provides an integrated suite of capabilities such as Plan, Code, Control, Build, Test, Release, Deploy and Measure to manage every stage of the software development lifecycle within a connected, continuous loop.

  4. Deploy

    Deploy standardizes and simplifies the rollout of software components across environments within the DevOps Loop. Its release automation tools improve deployment speed and reliability, providing visibility into multi-tiered deployments and orchestrating complex processes across environments and approval gates.

  5. Extending Product Function

    Learn how to extend the function of HCL DevOps Deploy (Deploy).

  6. Command-line client (CLI) reference

    CLI is a command-line interface that provides access to the HCL DevOps Deploy (Deploy) server. It can be used to find or set properties and to run numerous functions.

  7. CLI Commands

    The following list shows the commands that are available.

  8. importGenericProcess

    Import process from json file.
  • Release Notes

    This document includes information about the features introduced, a product overview, and installation instructions, as well as contact information of HCL Customer Support for this version of HCL DevOps Loop.

  • System Requirements

    This document includes information about hardware and software requirements for HCL DevOps Loop.

  • Getting Started

    HCL DevOps Loop is a platform designed to support the full DevOps lifecycle. The Getting Started section introduces key concepts and walks through the initial steps to help new users begin working with the platform.

  • Administration

    This section provides information on administration, installation, configuration, and integrations and teamspace management.

  • Working with Loops

    A loop is a workflow that connects DevOps activities of your team from planning and development through build, deployment, testing, and release phases.

  • Capabilities of DevOps Loop

    HCL DevOps Loop provides an integrated suite of capabilities such as Plan, Code, Control, Build, Test, Release, Deploy and Measure to manage every stage of the software development lifecycle within a connected, continuous loop.

    • Plan

      Plan is a change management software application within the DevOps Loop that supports seamless ticket creation, tracking, and comprehensive issue management. With customizable workflow automation, it helps teams to streamline and adapt processes to meet their unique business requirements while preparing work for the next stages of the loop.

    • Code

      Code is a cloud-based browser IDE in a dev container that is part of HCL DevOps Loop, allowing developers to write, compile, build, and debug code directly in the browser without requiring local setup.

    • Control

      Control manages source code within the DevOps Loop using GitHub compatible APIs that integrate with existing developer tools, workflows, and automation. It supports version management, collaboration, and code governance as development progresses.

    • Build

      Build offers the capability to build applications, manage continuous integration workflows, and store build artifacts.

    • Test

      The Test capability in DevOps Loop is powered by the DevOps Test application. Test centralizes test data, environments, test runs, and reports in a single web based interface within the DevOps Loop. It streamlines test management, execution, and tracking, providing greater efficiency and visibility to ensure quality throughout the loop.

    • Release

      Release standardizes and automates the software release lifecycle with the DevOps Loop, moving applications smoothly from preproduction to production. It provides predictable scheduling, integrates changes from planning tools, and gives stakeholders clear visibility into plans and milestones.

    • Deploy

      Deploy standardizes and simplifies the rollout of software components across environments within the DevOps Loop. Its release automation tools improve deployment speed and reliability, providing visibility into multi-tiered deployments and orchestrating complex processes across environments and approval gates.

      • Getting Started

        Quickly become productive with HCL DevOps Deploy (Deploy).

      • Installing an external agent for Deploy in DevOps Loop

        You can install and connect an external Deploy agent to a DevOps Loop instance running on Kubernetes (K8s), and IBM Kubernetes Service (IKS).

      • Integrating

        HCL DevOps Deploy (Deploy) supports integrations with other IBM® and HCL products, products from others, and certain cloud systems.

      • Administering

        Learn how to administer settings in HCL DevOps Deploy (Deploy) elements and communication between the elements.

      • Managing Security

        HCL DevOps Deploy (Deploy) uses a flexible team-based and role-based security model that maps to your organizational structure.

      • Modeling Software Deployment

        Modeling software deployment in HCL DevOps Deploy (Deploy) includes configuring components and component processes and adding those components to applications. Then, you use processes to deploy the components to environments.

      • Deploying

        Learn how to deploy applications in HCL DevOps Deploy (Deploy).

      • Reporting

        Provides several different deployment and security reports.

      • Extending Product Function

        Learn how to extend the function of HCL DevOps Deploy (Deploy).

        • Plug-ins

          The Deploy plug-ins provide tools for creating component processes and integrations. HCL provides plug-ins for several common deployment processes, and others are available to integrate with a wide variety of tools, such as middleware tools, databases, and servers.

        • Creating notification templates

          Notification templates are the basis for emails that the server sends to users after an event occurs on the server. You can create customized notification templates by modifying the default templates provided, or by creating new templates of your own.

        • REST API reference

          You can use these REST interfaces to automate tasks.

        • Command-line client (CLI) reference

          CLI is a command-line interface that provides access to the HCL DevOps Deploy (Deploy) server. It can be used to find or set properties and to run numerous functions.

          • Installing the command-line client

            The command-line client is available in an archive file that you can download from the server.

          • Command format

            To run a command, open a command-line window and specify the command and its parameters. In some cases, you must pass a JSON string with information for a command.

          • CLI Commands

            The following list shows the commands that are available.

            • addAgentPoolToTeam

              Add an agent pool to a team

            • addAgentServerPin

              Add public key pin for a server host to an agent

            • addAgentToPool

              Add an agent to an agent pool

            • addAgentToTeam

              Add an agent to a team

            • addApplicationToTeam

              Add an application to a team

            • addComponentResourcePropDef

              Create a component resource property definition

            • 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

            • addGroupToTeam

              Add a group to a role on a team

            • addJavaPackage

              Upload a Java package.

            • addPostProcessingScriptToTeam

              Add a post processing script to a team

            • 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

            • addWebhookToApplicationWithCredentials

              Add a webhook to an application

            • addWebhookToProcess

              Add a webhook to a process

            • addWebhookToProcessWithCredentials

              Add a webhook to a process

            • addZInventoryEntries

              Add entries to Z inventory.

            • archiveVersion

              Archive the given versions of a component

            • autoDiscoverResource

            • bulkAddAgentServerPin

              Add public key pins for server hosts to an agents in bulk

            • bulkGetAgentJavaHomes

              Get list of managed Java installations in bulk

            • bulkGetPreferredJavaPackageForAgent

              Get the preferred Java packages compatible with agents in bulk.

            • bulkInstallAgentJava

              Install Java packages as a new managed Java installations in bulk

            • bulkRemoveAgentServerPin

              Remove public key pins for server hosts from agents in bulk

            • bulkSetAgentJavaHome

              Set the configured JAVA_HOME of agents in bulk

            • bulkSetAgentKeypairPolicy

              Add public key pins for server hosts to an agents in bulk

            • bulkUninstallAgentJava

              Uninstall a managed Java installations in bulk

            • cancelApplicationPipelineExecution

              Cancel an application pipeline execution

            • cancelApplicationProcessRequest

              Cancel an application process request

            • cancelComponentProcessRequest

              Cancel an component process request

            • cancelMaintenanceBlackoutSeries

              Cancels the entire series for a recurring maintenance blackout.

            • cancelMaintenanceBlackoutSeriesEvent

              Cancels a single event in the series for a recurring maintenance blackout.

            • cancelProcessRequest

              Cancel an process request

            • cancelScheduledDeploymentSeries

              Cancels the entire series for a recurring scheduled deployment.

            • cancelScheduledDeploymentSeriesEvent

              Cancels a single event in the series for a recurring scheduled deployment.

            • cancelServerKeystoreImportTask

              Cancels an incomplete keystore import task. Incomplete tasks can be cancelled by any user with the required permission.

            • cancelWorkflow

              Cancel a workflow in progress

            • closeTask

              Approve or reject an approval task

            • completeServerKeystoreImportTask

              Complete a server keystore import 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

            • createApplicationPipeline

              Create a new application pipeline

            • createApplicationProcess

              Create an application process

            • createApplicationTemplate

              Create an application template from a JSON file

            • createAuthToken

              Create an authentication token

            • createAuthenticationRealm

              Create an AuthenticationRealm

            • createAuthorizationRealm

              Create an AuthorizationRealm

            • createBlueprintDesignerIntegration

              Create a blueprint designer integration from a JSON file

            • 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

            • createMaintenanceBlackout

              Create a maintenance blackout for the given date range. The date range cannot overlap with any existing maintenance blackout date ranges.

            • createManyVersions

              Create multiple component versions

            • createPostProcessingScript

              Create a post processing script from a JSON file

            • 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

            • createVaultAppRole

              Create a new Vault App Role

            • createVaultCertificate

              Create a new Vault Certificate

            • createVaultLdapUser

              Create a new Vault Ldap User

            • createVaultSecretStore

              Create a secret store.

            • 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

            • deleteApplicationPipeline

              Delete an application pipeline

            • deleteApplicationProcess

            • deleteApplicationTemplate

              Delete an application template

            • deleteAuthenticationRealm

              Delete an AuthenticationRealm

            • deleteAuthorizationRealm

              Delete an AuthorizationRealm

            • 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

            • deleteEnvironmentGate

              Delete the environment gate of a given environment

            • deleteEnvironmentTemplate

              Delete an environment template

            • deleteEnvironmentTemplateGate

              Delete the environment gate of a given environment template

            • deleteFrontendServer

              Delete a frontend server.

            • deleteGroup

              Delete a group

            • deleteJavaPackage

              Delete a java package.

            • deleteMaintenanceBlackout

              Cancel the given maintenance blackout. If it is a real event (synthetic=false) in a recurring, only the individual event is canceled. Synthetic events cannot be cancelled with this API.

            • deletePostProcessingScript

              Delete a post processing script.

            • deleteRedundantDesiredInventoryVersions

              Delete all redundant versions for a component in an environment

            • deleteResource

              Delete a resource

            • deleteResourceProperty

              Delete a resource property

            • deleteResourceRoleProperty

              Delete a resource role property

            • deleteSecretStore

              Delete a secret store.

            • deleteServerKeystoreEntry

              Delete a server keystore entry

            • deleteSnapshot

              Delete a snapshot

            • deleteStatus

              Delete a status

            • deleteTeam

              Delete a team

            • deleteUser

              Delete a user

            • deleteVaultAppRole

              Delete a Vault AppRole

            • deleteVaultCertificate

              Delete a Vault Certificate

            • deleteVaultLdapUser

              Delete a Vault Ldap User

            • deleteVersion

              Delete a version from a component

            • deleteWebhookTemplate

              Delete a webhook template

            • downloadJavaPackage

              Download available Java package.

            • downloadVersionArtifacts

              Download the artifacts of a component version

            • executeApplicationPipeline

              Execute an application pipeline

            • exportApplication

              Export an application to a json file.

            • exportApplicationProcess

              Export an application process

            • exportComponent

              Export a component to a json file.

            • exportComponentProcess

              Export a component process

            • exportComponentTemplate

              Export a component template to a json file.

            • exportComponentTemplateProcess

              Export a component template process

            • 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

            • forceCancelWorkflow

              Force cancel a workflow in progress

            • forceRenameAgent

              Rename an agent

            • forgetAgentCert

              Forget Agent Certificates

            • getAgent

              Get information about an agent

            • getAgentJavaHomes

              Get list of managed Java installations

            • getAgentMaintenanceTask

            • getAgentMaintenanceTasks

            • 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

            • getApplicationPipeline

              Get an application pipeline definition

            • getApplicationPipelineExecution

              Get an application pipeline execution

            • getApplicationPipelineExecutions

              Get a list of up to 100 application pipeline executions

            • getApplicationPipelines

              Get a list of up to 100 application pipelines

            • 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

            • getApplicationProcessRequestProperties

            • getApplicationProcessRequestStatus

              Request the status of an application process request

            • getApplicationProcessRequestVersions

              Get the Versions for 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

            • getAuthToken

              Get details for an authentication token

            • getAuthTokens

              Get all auth tokens

            • getAuthTokensForUser

              Get active authentication tokens for user

            • getAuthenticationRealm

              Get information about an AuthenticationRealm

            • getAuthenticationRealms

              Get information about all AuthenticationRealms

            • getAuthorizationRealm

              Get information about an AuthorizationRealm

            • getAuthorizationRealms

              Get information about all AuthorizationRealms

            • getAvailablePlugins

            • 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

            • getConfigurableAgentLicenseTypes

            • getCurrentActivityList

              Returns all child workflows of a parent request id if specified else returns all running workflow activities.

            • getDatabaseLatency

              Gather statistics by runnning a database latency test. Result times are in milliseconds. This may take several seconds.

            • 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

            • getEnvironmentCompliancy

              Get an inventory compliancy report for an environment.

            • getEnvironmentGate

              Get the environment gate of a given 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

            • getEnvironmentTemplateGate

              Get the environment gate of a given environment template

            • getEnvironmentTemplatePropDefs

              Get information about the property definitions for the environment template

            • getEnvironmentsInApplication

              Get information about all environments in an application

            • getExternalApprovalProcess

              Get information about an external approval process

            • getExternalApprovalProcesses

              Get all external approval processes

            • 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

            • getInstalledPlugins

            • 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.

            • getLLMVendorModels

              Gets the list of supported models for the given vendor.

            • getLLMVendors

              Gets the list of supported LLM vendors.

            • getLatestDesiredInventory

              Get the latest desired inventory for an environment.

            • getLatestSnapshotForEnvironment

              Get the latest snapshot deployed to an environment

            • getLoggingConfig

              Get logging configuration

            • getMaintenanceBlackouts

              Returns a list of all real and synthetic maintenance blackouts that start or end within the specified range. If no range is provided then all real maintenance blackouts will be returned (synthetic blackouts are not returned as the result would be infinite).

            • getOpenIDConnectRealms

              Get all realms that support OpenID Connect login.

            • getOverlappingArtifacts

              Get all artifacts overlapped in the given version

            • getPostProcessingScript

              Get information about a post processing script

            • getPostProcessingScripts

              Get a list of post processing scripts.

            • getPreferredJavaPackageForAgent

              Get the preferred Java package compatible with an agent.

            • getProcessRequest

            • 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

            • getResourceRoleProperties

              List resource role properties

            • getResourceRoleProperty

              Get a resource role property

            • getResourceTemplate

              Get a resource template

            • getResourceTemplateChildren

              Get all children or descendants of a resource template

            • getResources

              List resources

            • getResourcesInRecycleBin

              List resources in the recycle bin.

            • getResourcesWithComponentVersion

              List resources that have a specified component version

            • getSecretStore

              Get information about a secret store.

            • getSecretStores

              Get information about all secret stores.

            • getServerKeystoreImportTask

              Get a keystore import task

            • getServerKeystoreInfo

              Get information about the server keystore

            • 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.

            • getVaultAppRole

              Get information about a Vault AppRole

            • getVaultAppRoles

              List the Vault AppRoles for a Vault store

            • getVaultCertificate

              Get information about a Vault Certificate

            • getVaultCertificates

              List the Vault Certificates for a Vault store

            • getVaultLdapUser

              Get information about a Vault Ldap User

            • getVaultLdapUsers

              List the Vault Ldap Users for a Vault Secret Store

            • 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

            • getWorkflowTraceLogs

              Returns full workflow trace with execution logs as a zip file in the current directory.If the underlying workflow is not complete, an HTTP 412 response is returned.

            • getZOSVersionCumulativeManifest

              Get the cumulative manifest for a linked z/OS version

            • getZOSVersionDeployManifest

              Get a deploy manifest for deploying a version into an environment.

            • getZOSVersionsWithCommitId

              Get the versions from a component with a given commit ID.

            • importApplication

              Import application from json file.

            • importApplicationProcess

              Import an application process

            • importComponent

              Import component from json file.

            • importComponentProcess

              Import a component process

            • importComponentTemplate

              Import component template from json file.

            • importComponentTemplateProcess

              Import a component template process

            • 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

            • installLocalPlugin

            • installPlugin

            • listArtifacts

              Get the list of artifacts for a version

            • loadEnvironmentCompliancy

              Get the compliancy of a given environment

            • lockSnapshotConfiguration

              Lock a snapshot's configuration

            • lockSnapshotVersions

              Lock a snapshot's version list

            • lockUser

              Lock a user account

            • login

              Log in to the server

            • logout

              Log out of the server

            • moveResource

              Update a resource's parent

            • pauseWorkflow

              Pause a workflow in progress

            • prepareServerKeystoreImportTask

              Prepare for importing server keystore entries

            • previewUserLockEvent

            • 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

            • removeAgentServerPin

              Remove public key pin for a server host from an agent

            • removeApplicationFromTeam

              Remove an application from a team

            • removeComponentFromApplication

              Remove a component from an application.

            • removeComponentFromTeam

              Remove a component from a team

            • removeComponentResourcePropDef

              Delete a component resource property definition

            • 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

            • removeInventoryForUnmappedComponents

              Removes environment inventory for components with no resources in the enviroment resources.

            • 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

            • restoreArtifacts

              Restore artifacts of an archived version

            • restoreFromRecycleBin

              Restore from recycle bin.

            • resumeWorkflow

              Resume a workflow in progress

            • revokeAuthToken

              Revoke an authentication token

            • rollbackZInventoryEntries

              Rollback Z inventory.

            • saveEnvironmentGate

              Save the environment gate of a given environment. Environment gates are JSON objects consisting of operators "OR", "AND", and "NOT", as well as status UUIDs. A valid operator is a JSON Object with a single key corresponding to one of the three operator types, and with a list of operators or UUIDs as its value. A valid gate begins with an enclosing OR operator containing one or more AND operators. AND operators can contain only UUIDs or NOT operators. NOT operators must contain a single UUID which corresponds to a known version or snapshot status.

            • saveEnvironmentTemplateGate

              Save the environment gate of a given environment template. Environment gates are JSON objects consisting of operators "OR", "AND", and "NOT", as well as status UUIDs. A valid operator is a JSON Object with a single key corresponding to one of the three operator types, and with a list of operators or UUIDs as its value. A valid gate begins with an enclosing OR operator containing one or more AND operators. AND operators can contain only UUIDs or NOT operators. NOT operators must contain a single UUID which corresponds to a known version or snapshot status.

            • savePostProcessingScript

              Get information about a post processing script

            • searchZInventoryEntries

              Search Z inventory.

            • setAgentJavaHome

              Set the configured JAVA_HOME of an agent

            • setAgentKeypairPolicy

              Set or modify an agent's keypair policy

            • setAgentLicenseType

              Set the license for an agent

            • setAgentProperty

              Set a property on a agent

            • setAgentUnavailable

            • 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

            • setLoggingConfig

              Get logging configuration

            • setPreferredJavaPackage

              Sets a package as preferred for its OS and CPU, unsetting the previously preferred package if there was one.

            • setResourceProperty

              Set a property on a resource

            • setResourceRoleProperty

              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

            • testVaultAppRole

              Test resolving a value from a Vault AppRole.

            • testVaultCertificate

              Test resolving a value from a Vault Certificate.

            • testVaultLdapUser

              Test resolving a value from a Vault Ldap User.

            • uninstallAgentJava

              Uninstall a managed Java installation

            • unlockUser

              Unlock a user account and clear failed login attempts.

            • unsetPreferredJavaPackage

              Unsets a package as preferred for its OS and CPU, leaving no package as preferred.

            • updateAgent

              Update agent settings

            • updateApplicationPipeline

              Update an application pipeline definition

            • updateApplicationTemplate

              Update an application template

            • updateApplicationTemplatePropDefs

              Update an application template prop sheet def from a JSON file.

            • updateAuthenticationRealm

              Update the basic settings of an AuthenticationRealm

            • updateAuthorizationRealm

              Update the basic settings of an AuthorizationRealm

            • updateComponent

              Update the basic settings of a component

            • updateComponentResourcePropDef

              Update a component resource property definition

            • updateComponentTemplatePropDefs

              Update a component template prop-def sheet from a JSON file. Replaces the property definitions.

            • updateEnvironment

              Update an environment

            • updateEnvironmentProperty

              Update a component environment property

            • updateEnvironmentTemplate

              Update the basic settings of an environment template

            • updateEnvironmentTemplatePropDefs

              Update an environment template prop sheet def from a JSON file.

            • updateExternalApprovalProcess

              Update the basic settings of an external approval process

            • updateMaintenanceBlackout

              Modifies the given maintenance blackout. A date cannot be modified if it has already occurred. For recurring blackouts, only real events (synthetic=false) can be updated. For recurring blackouts, updating the date of the real event also alters the start and duration of future events within each recurrence time interval (day, week, or month).

            • updateResource

              Update a resource

            • updateResourceTemplate

              Update a resource template from a JSON file

            • updateRoleActions

              Update any number of Actions for one or more Roles + Types

            • updateTeam

              Update a team

            • updateUser

              Update a user

            • updateUsersInAuthRealm

              Update all users in an authentication realm

            • updateVaultAppRole

              Update a Vault AppRole

            • updateVaultCertificate

              Update a Vault Certificate

            • updateVaultLdapUser

              Update a new Vault Ldap User

            • updateVaultSecretStore

              Update a secret store.

            • updateWebhookForApplication

              Update an application webhook

            • updateWebhookForApplicationWithCredentials

              Update an application webhook

            • updateWebhookForProcess

              Updates a webhook for a process

            • updateWebhookForProcessWithCredentials

              Updates a webhook for a process.

            • updateWebhookTemplate

              Update a webhook template

            • upgradeAgent

              Upgrade an agent

        • Process-as-code feature

          Programmatically manage processes with PAC language.

        • DevOps Deploy MCP server

          The Model Context Protocol (MCP) server of HCL DevOps Deploy (Deploy) enables AI models (like LLMs) to utilize specialized Deploy MCP tools. By using these tools, you can run crucial deployment tasks on an MCP client simply through chat prompts.

      • Troubleshooting and Support

        Learn how to troubleshoot some common issues with HCL DevOps Deploy (Deploy).

    • Measure

      Measure provides end-to-end visibility into the DevOps Loop, giving teams to track how value is created throughout the work flow. It consolidates testing, security, and performance metrics to identify bottlenecks, team issues, and opportunities for improvement while strengthening governance across the organization.

  • Loop Genie overview - Tech Preview

    Loop Genie is an AI-powered, multi-agent assistant integrated into DevOps Loop. It provides a unified conversational interface to perform tasks and retrieve information across multiple DevOps Loop capabilities.

  • Troubleshooting
  • Offline Documentation (PDF)

    You can access the following link to view or download the release notes, system requirements, and user documentation for DevOps Loop in a Portable Document Format (PDF) file.

  • Security Considerations

    This document describes the actions that you can take to ensure that your installation is secure, customize your security settings, and set up user access controls in HCL DevOps Loop.

  • Notices

    This document provides information about copyright, trademarks, terms and conditions for the product documentation.

 Feedback

importGenericProcess

Import process from json file.

Format

udclient [global-args...] [global-flags...]
  importGenericProcess [parameters]

Parameters

Table 1. Parameters
Parameter Type Required Description
disposition string true create or update

Related REST command: Import process from json file..

  • Share: Email
  • Twitter
  • Disclaimer
  • Privacy
  • Terms of use
  • Cookie Preferences