Veeam Get

Veeam Get

Certified
Enterprise Edition

Get a Veeam Backup & Replication job session

Fetches a single job session by id. When waitForCompletion is true, polls the session at pollInterval until it reaches a terminal state (SUCCESS, WARNING, or FAILED), refreshing the OAuth 2.0 access token if it is about to expire, and fails with a clear error if timeout is reached first. A session with a non-null end time is also treated as finished even if its normalized status is UNKNOWN (for example a canceled session), so polling does not wait until timeout in that case.

yaml
type: io.kestra.plugin.ee.veeam.sessions.Get

Start a backup job then wait for its session to complete.

yaml
id: run_and_wait_veeam_backup
namespace: company.team

tasks:
  - id: start_job
    type: io.kestra.plugin.ee.veeam.jobs.Start
    host: "{{ secret('VEEAM_HOST') }}"
    username: "{{ secret('VEEAM_USERNAME') }}"
    password: "{{ secret('VEEAM_PASSWORD') }}"
    jobId: "3f6a1e2b-1234-4a5b-9c3d-0a1b2c3d4e5f"

  - id: wait_for_completion
    type: io.kestra.plugin.ee.veeam.sessions.Get
    host: "{{ secret('VEEAM_HOST') }}"
    username: "{{ secret('VEEAM_USERNAME') }}"
    password: "{{ secret('VEEAM_PASSWORD') }}"
    sessionId: "{{ outputs.start_job.sessionId }}"
    waitForCompletion: true
    pollInterval: PT10S
    timeout: PT30M
Properties

Veeam Backup & Replication server host

Hostname or IP address of the Veeam Backup & Replication server exposing the REST API.

Password

Password for username. Treat it as a secret, e.g. {{ secret('VEEAM_PASSWORD') }}.

Session id

Username

Veeam Backup & Replication account used for the OAuth 2.0 password grant.

Default1.3-rev1

API version

Value sent as the mandatory x-api-version header on every request, including authentication. Must match a version supported by the target server; a missing or unsupported value causes VBR to reject the request with HTTP 400. Defaults to 1.3-rev1 (VBR 12.1 and later).

HTTP client configuration

Optional HTTP client overrides (timeouts, proxy, TLS). Veeam Backup & Replication servers ship a self-signed certificate by default: set options.ssl.insecureTrustAllCertificates: true, or provide a trust store, otherwise the first request fails with a TLS handshake error rather than a clear authentication error.

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

type*Requiredobject
passwordstring

The password for HTTP basic authentication.

usernamestring

The username for HTTP basic authentication.

type*Requiredobject
tokenstring

The token for bearer token authentication.

type*Requiredobject
passwordstring

The password for HTTP Digest authentication.

usernamestring

The username for HTTP Digest authentication.

basicAuthPasswordDeprecatedstring

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

basicAuthUserDeprecatedstring

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

connectTimeoutDeprecatedstring
Formatduration

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

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

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.

logLevelDeprecatedstring
Possible Values
ALLTRACEDEBUGINFOWARNERROROFFNOT_SPECIFIED

The log level for the HTTP client.

logsarray
SubTypestring
Possible Values
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODY

The enabled log.

maxContentLengthDeprecatedinteger

The maximum content length of the response.

proxy

The proxy configuration.

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.

proxyAddressDeprecatedstring

The address of the proxy server.

proxyPasswordDeprecatedstring

The password for proxy authentication.

proxyPortDeprecatedinteger

The port of the proxy server.

proxyTypeDeprecatedstring
Possible Values
DIRECTHTTPSOCKS

The type of proxy to use.

proxyUsernameDeprecatedstring

The username for proxy authentication.

readIdleTimeoutDeprecatedstring
Formatduration

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

readTimeoutDeprecatedstring
Formatduration

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

ssl

The SSL request options

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.

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.

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

DefaultPT10S

Poll interval

Delay between two polls when waitForCompletion is true. Defaults to 10 seconds.

Default9419

REST API port

TCP port of the Veeam Backup & Replication REST API. Defaults to 9419.

DefaultPT30M

Timeout

Maximum time to wait for a terminal state before failing. Defaults to 30 minutes.

Defaultfalse

Wait for completion

When true, polls the session until it reaches a terminal state instead of returning its current state immediately. A session that already has an end time is considered finished even if its normalized status is UNKNOWN.

Formatdate-time

Session creation time

Formatdate-time

Session end time

Populated once the session has reached a terminal state.

Session id

Parent job id

Session name

Raw session result

Raw result value returned by the API, for example None, Success, Warning, or Failed.

Raw session state

Raw state value returned by the API, for example Working, Stopped, or Idle.

Possible Values
RUNNINGSUCCESSWARNINGFAILEDUNKNOWN

Normalized session status

Derived from state/result: RUNNING, SUCCESS, WARNING, FAILED, or UNKNOWN.

More Plugins in this Category

NetBox (EE)
NetBox
Enterprise

Enterprise NetBox tasks to create, update, and query devices, IP addresses, and sites over the NetBox API.

Infrastructure

7 tasks

4 blueprints

AS400
AS400

Tasks that connect to AS400 via JDBC to run queries and loads.

DataInfrastructure

3 tasks