Learn how to extend the function of HCL DevOps Deploy (Deploy).
You can use these REST interfaces to automate tasks.
The following list shows the commands that are available for the HCL DevOps Deploy (Deploy) server.
The HCL plug-ins provide tools for creating component processes and integrations. HCL plug-ins 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.
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.
Many different programs can run REST commands. To run the command, you call a method on a REST resource and pass parameters or a request in JSON format.
Many REST and command-line client commands have examples in their help topics. A few more examples using various programming languages and scenarios are provided here. The commands are similar for the server.
The way that you authenticate to run REST commands depends on how the server is set up and the tool that you are using to run the commands.
Resources for creating, editing, and deleting agents.
Resources for working with applications, including manipulating the components and environments that are associated with applications.
Resources for requesting application processes.
Resources for working with application templates.
Resources for working with component processes.
This command creates and Environment from a template and attaches it to the specified application.
A version is considered redundant if all of its files have been replaced by versions that have been deployed more recently to the same environment.
Get all artifacts that are overlapped by later versions. A version is considered safe to rollback if it does not contain overlapping artifacts. It is risky to roll back a version if that version contains overlapping artifacts. This command applies only to z/OS component versions.
This command returns a listing of all resources added as base resources to an environment.
This command returns a JSON array of all of the desired inventory for an environment. It optionally groups the desired inventory by component.
These properties are defined on the component and their values are set on the environment.
This command returns a JSON representation of an environment.
This command returns a JSON array of all of the desired inventory for an environment.
This command provisions an instance of an application blueprint and creates an application environment based on that blueprint.
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.
This command will set a component property value specifically for this environment.
Resources for editing and creating generic processes.
Resource for working with resource templates.
Resources for listing tags.
Resources for manipulating Z inventory.
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.
Programmatically manage processes with PAC language.