HP OO Pause

HP OO Pause
Certified
Enterprise Edition
Pause HP OO executions

Pauses one or more running HP Operations Orchestration executions.

yaml
type: io.kestra.plugin.ee.hpoo.executions.Pause

Examples

Pause running executions

yaml
id: hpoo_pause
namespace: company.team

tasks:
  - id: pause
    type: io.kestra.plugin.ee.hpoo.executions.Pause
    host: https://oo.company.com:8443
    username: admin
    password: "{{ secret('HPOO_PASSWORD') }}"
    executionIds:
      - "101000011"
      - "101000012"

Properties

executionIds *array

SubTypestring

Execution IDs

One or more HP OO execution IDs to act on. Sent as a comma-separated path segment.

host *string

HP OO base URL

Base HTTPS endpoint for the OO instance (e.g. https://oo.company.com: 8443). Trailing slash is stripped.

apiMode string

DefaultCLASSIC

Possible Values

CLASSICCONTAINERIZED

API mode

CLASSIC for traditional on-prem OO (HTTP Basic at /oo/rest/v2). CONTAINERIZED for the Kubernetes-deployed OO (token auth at /rest/v1/{tenantId}).

failOnFailure booleanstring

Defaulttrue

Fail on partial failure

If true (default), the task fails when any execution in the response is not SUCCESS. Set to false to always succeed and only surface results in the output.

options string

HTTP client options

Optional overrides for timeouts, proxies, or headers.

Definitions

io.kestra.core.http.client.configurations.HttpConfiguration

allowFailedbooleanstring

Defaultfalse

If true, allow a failed response code (response code >= 400)

allowedResponseCodesarray

SubTypeinteger

List of response code allowed for this request

auth

The authentication to use.

io.kestra.core.http.client.configurations.BasicAuthConfiguration

type*object

passwordstring

The password for HTTP basic authentication.

usernamestring

The username for HTTP basic authentication.

io.kestra.core.http.client.configurations.BearerAuthConfiguration

type*object

tokenstring

The token for bearer token authentication.

io.kestra.core.http.client.configurations.DigestAuthConfiguration

type*object

passwordstring

The password for HTTP Digest authentication.

usernamestring

The username for HTTP Digest authentication.

basicAuthPasswordstring

The password for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.

basicAuthUserstring

The username for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.

connectTimeoutstring

Formatduration

The time allowed to establish a connection to the server before failing.

connectionPoolIdleTimeoutstring

Formatduration

The time an idle connection can remain in the client's connection pool before being closed.

defaultCharsetstring

DefaultUTF-8

The default charset for the request.

java.nio.charset.Charset

enabledTcpExtendedKeepAlivebooleanstring

Defaulttrue

Whether to enable TCP Keep-Alive extended socket options (TCP_KEEPIDLE, TCP_KEEPINTERVAL, TCP_KEEPCOUNT).

Set to false when running on Windows workers, as these extended socket options are not supported by the Windows JDK and will cause connection failures.

followRedirectsbooleanstring

Defaulttrue

Whether redirects should be followed automatically.

logLevelstring

Possible Values

ALLTRACEDEBUGINFOWARNERROROFFNOT_SPECIFIED

The log level for the HTTP client.

logsarray

SubTypestring

Possible Values

REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODY

The enabled log.

maxContentLengthinteger

The maximum content length of the response.

proxy

The proxy configuration.

io.kestra.core.http.client.configurations.ProxyConfiguration

addressstring

The address of the proxy server.

passwordstring

The password for proxy authentication.

portintegerstring

The port of the proxy server.

typestring

DefaultDIRECT

Possible Values

DIRECTHTTPSOCKS

The type of proxy to use.

usernamestring

The username for proxy authentication.

proxyAddressstring

The address of the proxy server.

proxyPasswordstring

The password for proxy authentication.

proxyPortinteger

The port of the proxy server.

proxyTypestring

Possible Values

DIRECTHTTPSOCKS

The type of proxy to use.

proxyUsernamestring

The username for proxy authentication.

readIdleTimeoutstring

Formatduration

The time allowed for a read connection to remain idle before closing it.

readTimeoutstring

Formatduration

The maximum time allowed for reading data from the server before failing.

ssl

The SSL request options

io.kestra.core.http.client.configurations.SslOptions

insecureTrustAllCertificatesbooleanstring

Whether to disable checking of the remote SSL certificate.

Only applies if no trust store is configured. Note: This makes the SSL connection insecure and should only be used for testing. If you are using a self-signed certificate, set up a trust store instead.

timeout

The timeout configuration.

io.kestra.core.http.client.configurations.TimeoutConfiguration

connectTimeoutstring

The time allowed to establish a connection to the server before failing.

readIdleTimeoutstring

DefaultPT5M

The time allowed for a read connection to remain idle before closing it.

password string

Password

Password for Basic Auth. Required when apiMode is CLASSIC.

pluginDefaultsRef string

Reference (ref) of the pluginDefaults to apply to this task.

tenantId string

Tenant ID

OO tenant identifier. Required when apiMode is CONTAINERIZED.

token string

Auth token

Token to send as X-Auth-Token. Required when apiMode is CONTAINERIZED. Obtain it from POST /idm-service/v3.0/tokens or any external mechanism.