Usage

Create Multiple Resources

The Create Multiple Resources step provides the ability to create multiple resources using one JSON file or JSON text body. The format of this JSON body follows the HCL Launch resource/create REST endpoint. See Create a resource for information about this endpoint.

To create multiple resources, create multiple JSON resource objects inside of a JSON array as follows:

[{"name": "Name for the resource.",
"agent": "(Optional) Name or ID of an agent to use for automation.",
"agentPool": "(Optional) Name or ID of an agent pool to use for automation.",
"parent": "(Optional) ID or path to parent resource.",
"role": "(Optional) Name or ID of a resource role.",
"componentTag": "(Optional) Name or ID of a component tag."},
{"name": "Name for the resource.",
"agent": "(Optional) Name or ID of an agent to use for automation.",
"agentPool": "(Optional) Name or ID of an agent pool to use for automation.",
"parent": "(Optional) ID or path to parent resource.",
"role": "(Optional) Name or ID of a resource role.",
"componentTag": "(Optional) Name or ID of a component tag."}]

Steps

The following process steps are available in the HCL Launch Resources plugin.

• Add Resource To Team
• Add Tag to Resource
• Apply Resource Template
• Check If Resource Exists
• Check If Resource Has Role
• Create Resource
• Delete Agent
• Delete Many Agents
• Delete Many Resources
• Delete Resource
• Delete Resource Inventory For Component
• Get Agent Details
• Get Agent Property
• Get Component Version For Resource
• Get Resource Property
• Get Resource Role Property
• Install Agent with SSH
• Map Component Tag to Resource
• Remove Tag From Resource
• Set Agent Property
• Set Resource Property
• Set Resource Role Property
• Synchronize Resources
• Wait for Resources
• Create Multiple Resources

Add Resource To Team

Adds a resource to a team for a given type classification.

Add Tag to Resource

Add a tag to a resource.

Apply Resource Template

Applies a resource template to a resource.

Check If Resource Exists

This step will succeed if the resource exists and fail if it does not.

Check If Resource Has Role

Step succeeds if resource has the specified role and fails if it doesnt.

Create Resource

Creates a resource. The resource could be a group, component resource, agent resource,
or agent pool resource.

Delete Agent

Delete the specified agent.

Delete Many Agents

Deletes agents, specified as a comma-separated list.

Delete Many Resources

Deletes resources, specified as a comma-separated list.

Delete Resource

Deletes the specified resource.

Delete Resource Inventory For Component

Deletes all inventory entries on a resource for a given component. Can filter by version
and version status.

Get Agent Details

Retrieve basic configuration information about a agent.

Get Agent Property

Gets an agent property, given an agent and a property name. Name/value pair is outputted
on this step.

Get Component Version For Resource

Takes a component and a resource, shows what version of that component exists on that resource.

Get Resource Property

Get a resource property, given a resource and a property name. Name/value pair is
outputted on this step.

Get Resource Role Property

Get a resource role property value, given a resource, role name and a property name.
Name/value pair is outputted on this step.

Install Agent with SSH

Installs an agent to a remote system over SSH.

Map Component Tag to Resource

Creates a new component tag resource. Maps a Component Tag to a previously created agent.

Remove Tag From Resource

Remove a tag from a resource.

Set Agent Property

Sets a property for an agent.

Set Resource Property

Sets a property for a resource.

Set Resource Role Property

Sets a property for a resource role. Property must be pre-defined on the role.

Synchronize Resources

Synchronize one resource tree with another.

Wait for Resources

Wait for one or more resources to be online.

Create Multiple Resources

Creates multiple resources using JSON format.