ibm 1.78.0, Apr 30 25

ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.BackupRecoveryAgentUpgradeTask

Explore with Pulumi AI

ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const backupRecoveryAgentUpgradeTaskInstance = new ibm.BackupRecoveryAgentUpgradeTask("backupRecoveryAgentUpgradeTaskInstance", {xIbmTenantId: "x_ibm_tenant_id"});

import pulumi
import pulumi_ibm as ibm

backup_recovery_agent_upgrade_task_instance = ibm.BackupRecoveryAgentUpgradeTask("backupRecoveryAgentUpgradeTaskInstance", x_ibm_tenant_id="x_ibm_tenant_id")

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewBackupRecoveryAgentUpgradeTask(ctx, "backupRecoveryAgentUpgradeTaskInstance", &ibm.BackupRecoveryAgentUpgradeTaskArgs{
			XIbmTenantId: pulumi.String("x_ibm_tenant_id"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var backupRecoveryAgentUpgradeTaskInstance = new Ibm.BackupRecoveryAgentUpgradeTask("backupRecoveryAgentUpgradeTaskInstance", new()
    {
        XIbmTenantId = "x_ibm_tenant_id",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.BackupRecoveryAgentUpgradeTask;
import com.pulumi.ibm.BackupRecoveryAgentUpgradeTaskArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var backupRecoveryAgentUpgradeTaskInstance = new BackupRecoveryAgentUpgradeTask("backupRecoveryAgentUpgradeTaskInstance", BackupRecoveryAgentUpgradeTaskArgs.builder()
            .xIbmTenantId("x_ibm_tenant_id")
            .build());

    }
}

resources:
  backupRecoveryAgentUpgradeTaskInstance:
    type: ibm:BackupRecoveryAgentUpgradeTask
    properties:
      xIbmTenantId: x_ibm_tenant_id

Create BackupRecoveryAgentUpgradeTask Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new BackupRecoveryAgentUpgradeTask(name: string, args: BackupRecoveryAgentUpgradeTaskArgs, opts?: CustomResourceOptions);

@overload
def BackupRecoveryAgentUpgradeTask(resource_name: str,
                                   args: BackupRecoveryAgentUpgradeTaskArgs,
                                   opts: Optional[ResourceOptions] = None)

@overload
def BackupRecoveryAgentUpgradeTask(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   x_ibm_tenant_id: Optional[str] = None,
                                   agent_ids: Optional[Sequence[float]] = None,
                                   backup_recovery_agent_upgrade_task_id: Optional[str] = None,
                                   description: Optional[str] = None,
                                   name: Optional[str] = None,
                                   retry_task_id: Optional[float] = None,
                                   schedule_end_time_usecs: Optional[float] = None,
                                   schedule_time_usecs: Optional[float] = None)

func NewBackupRecoveryAgentUpgradeTask(ctx *Context, name string, args BackupRecoveryAgentUpgradeTaskArgs, opts ...ResourceOption) (*BackupRecoveryAgentUpgradeTask, error)

public BackupRecoveryAgentUpgradeTask(string name, BackupRecoveryAgentUpgradeTaskArgs args, CustomResourceOptions? opts = null)

public BackupRecoveryAgentUpgradeTask(String name, BackupRecoveryAgentUpgradeTaskArgs args)
public BackupRecoveryAgentUpgradeTask(String name, BackupRecoveryAgentUpgradeTaskArgs args, CustomResourceOptions options)

type: ibm:BackupRecoveryAgentUpgradeTask
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args BackupRecoveryAgentUpgradeTaskArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args BackupRecoveryAgentUpgradeTaskArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args BackupRecoveryAgentUpgradeTaskArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args BackupRecoveryAgentUpgradeTaskArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args BackupRecoveryAgentUpgradeTaskArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var backupRecoveryAgentUpgradeTaskResource = new Ibm.BackupRecoveryAgentUpgradeTask("backupRecoveryAgentUpgradeTaskResource", new()
{
    XIbmTenantId = "string",
    AgentIds = new[]
    {
        0,
    },
    BackupRecoveryAgentUpgradeTaskId = "string",
    Description = "string",
    Name = "string",
    RetryTaskId = 0,
    ScheduleEndTimeUsecs = 0,
    ScheduleTimeUsecs = 0,
});

example, err := ibm.NewBackupRecoveryAgentUpgradeTask(ctx, "backupRecoveryAgentUpgradeTaskResource", &ibm.BackupRecoveryAgentUpgradeTaskArgs{
	XIbmTenantId: pulumi.String("string"),
	AgentIds: pulumi.Float64Array{
		pulumi.Float64(0),
	},
	BackupRecoveryAgentUpgradeTaskId: pulumi.String("string"),
	Description:                      pulumi.String("string"),
	Name:                             pulumi.String("string"),
	RetryTaskId:                      pulumi.Float64(0),
	ScheduleEndTimeUsecs:             pulumi.Float64(0),
	ScheduleTimeUsecs:                pulumi.Float64(0),
})

var backupRecoveryAgentUpgradeTaskResource = new BackupRecoveryAgentUpgradeTask("backupRecoveryAgentUpgradeTaskResource", BackupRecoveryAgentUpgradeTaskArgs.builder()
    .xIbmTenantId("string")
    .agentIds(0)
    .backupRecoveryAgentUpgradeTaskId("string")
    .description("string")
    .name("string")
    .retryTaskId(0)
    .scheduleEndTimeUsecs(0)
    .scheduleTimeUsecs(0)
    .build());

backup_recovery_agent_upgrade_task_resource = ibm.BackupRecoveryAgentUpgradeTask("backupRecoveryAgentUpgradeTaskResource",
    x_ibm_tenant_id="string",
    agent_ids=[0],
    backup_recovery_agent_upgrade_task_id="string",
    description="string",
    name="string",
    retry_task_id=0,
    schedule_end_time_usecs=0,
    schedule_time_usecs=0)

const backupRecoveryAgentUpgradeTaskResource = new ibm.BackupRecoveryAgentUpgradeTask("backupRecoveryAgentUpgradeTaskResource", {
    xIbmTenantId: "string",
    agentIds: [0],
    backupRecoveryAgentUpgradeTaskId: "string",
    description: "string",
    name: "string",
    retryTaskId: 0,
    scheduleEndTimeUsecs: 0,
    scheduleTimeUsecs: 0,
});

type: ibm:BackupRecoveryAgentUpgradeTask
properties:
    agentIds:
        - 0
    backupRecoveryAgentUpgradeTaskId: string
    description: string
    name: string
    retryTaskId: 0
    scheduleEndTimeUsecs: 0
    scheduleTimeUsecs: 0
    xIbmTenantId: string

BackupRecoveryAgentUpgradeTask Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The BackupRecoveryAgentUpgradeTask resource accepts the following input properties:

XIbmTenantId string: Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
AgentIds List<double>: Specifies the agents upgraded in the task.
BackupRecoveryAgentUpgradeTaskId string: (Integer) Specifies the ID of the agent.
Description string: Specifies the description of the task.
Name string: Specifies the name of the task.
RetryTaskId double: Specifies ID of a task which is to be retried.
ScheduleEndTimeUsecs double: Specifies the time before which the upgrade task should start execution as a Unix epoch Timestamp (in microseconds). If this is not specified the task will start anytime after scheduleTimeUsecs.
ScheduleTimeUsecs double: Specifies the time when the task should start execution as a Unix epoch Timestamp (in microseconds). If no schedule is specified, the task will start immediately.

XIbmTenantId string: Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
AgentIds []float64: Specifies the agents upgraded in the task.
BackupRecoveryAgentUpgradeTaskId string: (Integer) Specifies the ID of the agent.
Description string: Specifies the description of the task.
Name string: Specifies the name of the task.
RetryTaskId float64: Specifies ID of a task which is to be retried.
ScheduleEndTimeUsecs float64: Specifies the time before which the upgrade task should start execution as a Unix epoch Timestamp (in microseconds). If this is not specified the task will start anytime after scheduleTimeUsecs.
ScheduleTimeUsecs float64: Specifies the time when the task should start execution as a Unix epoch Timestamp (in microseconds). If no schedule is specified, the task will start immediately.

xIbmTenantId String: Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
agentIds List<Double>: Specifies the agents upgraded in the task.
backupRecoveryAgentUpgradeTaskId String: (Integer) Specifies the ID of the agent.
description String: Specifies the description of the task.
name String: Specifies the name of the task.
retryTaskId Double: Specifies ID of a task which is to be retried.
scheduleEndTimeUsecs Double: Specifies the time before which the upgrade task should start execution as a Unix epoch Timestamp (in microseconds). If this is not specified the task will start anytime after scheduleTimeUsecs.
scheduleTimeUsecs Double: Specifies the time when the task should start execution as a Unix epoch Timestamp (in microseconds). If no schedule is specified, the task will start immediately.

xIbmTenantId string: Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
agentIds number[]: Specifies the agents upgraded in the task.
backupRecoveryAgentUpgradeTaskId string: (Integer) Specifies the ID of the agent.
description string: Specifies the description of the task.
name string: Specifies the name of the task.
retryTaskId number: Specifies ID of a task which is to be retried.
scheduleEndTimeUsecs number: Specifies the time before which the upgrade task should start execution as a Unix epoch Timestamp (in microseconds). If this is not specified the task will start anytime after scheduleTimeUsecs.
scheduleTimeUsecs number: Specifies the time when the task should start execution as a Unix epoch Timestamp (in microseconds). If no schedule is specified, the task will start immediately.

x_ibm_tenant_id str: Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
agent_ids Sequence[float]: Specifies the agents upgraded in the task.
backup_recovery_agent_upgrade_task_id str: (Integer) Specifies the ID of the agent.
description str: Specifies the description of the task.
name str: Specifies the name of the task.
retry_task_id float: Specifies ID of a task which is to be retried.
schedule_end_time_usecs float: Specifies the time before which the upgrade task should start execution as a Unix epoch Timestamp (in microseconds). If this is not specified the task will start anytime after scheduleTimeUsecs.
schedule_time_usecs float: Specifies the time when the task should start execution as a Unix epoch Timestamp (in microseconds). If no schedule is specified, the task will start immediately.

xIbmTenantId String: Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
agentIds List<Number>: Specifies the agents upgraded in the task.
backupRecoveryAgentUpgradeTaskId String: (Integer) Specifies the ID of the agent.
description String: Specifies the description of the task.
name String: Specifies the name of the task.
retryTaskId Number: Specifies ID of a task which is to be retried.
scheduleEndTimeUsecs Number: Specifies the time before which the upgrade task should start execution as a Unix epoch Timestamp (in microseconds). If this is not specified the task will start anytime after scheduleTimeUsecs.
scheduleTimeUsecs Number: Specifies the time when the task should start execution as a Unix epoch Timestamp (in microseconds). If no schedule is specified, the task will start immediately.

Outputs

All input properties are implicitly available as output properties. Additionally, the BackupRecoveryAgentUpgradeTask resource produces the following output properties:

Agents List<BackupRecoveryAgentUpgradeTaskAgent>

(List) Specifies the upgrade information for each agent. Nested schema for agents:

ClusterVersion string

(String) Specifies the version to which agents are upgraded.

EndTimeUsecs double

(Integer) Specifies the time when the upgrade task completed execution as a Unix epoch Timestamp (in microseconds).

Errors List<BackupRecoveryAgentUpgradeTaskError>

(List) Object that holds the error object. Nested schema for error:

Id string

The provider-assigned unique ID for this managed resource.

IsRetryable bool

(Boolean) Specifies if a task can be retried.

RetriedTaskId double

(Integer) Specifies ID of a task which was retried if type is 'Retry'.

StartTimeUsecs double

(Integer) Specifies the time, as a Unix epoch timestamp in microseconds, when the task started execution.

Status string

(String) Specifies the status of the task. 'Scheduled' indicates that the upgrade task is yet to start. 'Running' indicates that the upgrade task has started execution. 'Succeeded' indicates that the upgrade task completed without an error. 'Failed' indicates that upgrade has failed for all agents. 'PartiallyFailed' indicates that upgrade has failed for some agents.

Constraints: Allowable values are: Scheduled, Running, Succeeded, Failed, PartiallyFailed, Canceled.

Type string

(String) Specifes the type of task. 'Auto' indicates an auto agent upgrade task which is started after a cluster upgrade. 'Manual' indicates a schedule based agent upgrade task. 'Retry' indicates an agent upgrade task which was retried.

Constraints: Allowable values are: Auto, Manual, Retry.

Agents []BackupRecoveryAgentUpgradeTaskAgent

(List) Specifies the upgrade information for each agent. Nested schema for agents:

ClusterVersion string

(String) Specifies the version to which agents are upgraded.

EndTimeUsecs float64

(Integer) Specifies the time when the upgrade task completed execution as a Unix epoch Timestamp (in microseconds).

Errors []BackupRecoveryAgentUpgradeTaskError

(List) Object that holds the error object. Nested schema for error:

Id string

The provider-assigned unique ID for this managed resource.

IsRetryable bool

(Boolean) Specifies if a task can be retried.

RetriedTaskId float64

(Integer) Specifies ID of a task which was retried if type is 'Retry'.

StartTimeUsecs float64

(Integer) Specifies the time, as a Unix epoch timestamp in microseconds, when the task started execution.

Status string

Constraints: Allowable values are: Scheduled, Running, Succeeded, Failed, PartiallyFailed, Canceled.

Type string

Constraints: Allowable values are: Auto, Manual, Retry.

agents List<BackupRecoveryAgentUpgradeTaskAgent>

(List) Specifies the upgrade information for each agent. Nested schema for agents:

clusterVersion String

(String) Specifies the version to which agents are upgraded.

endTimeUsecs Double

(Integer) Specifies the time when the upgrade task completed execution as a Unix epoch Timestamp (in microseconds).

errors List<BackupRecoveryAgentUpgradeTaskError>

(List) Object that holds the error object. Nested schema for error:

id String

The provider-assigned unique ID for this managed resource.

isRetryable Boolean

(Boolean) Specifies if a task can be retried.

retriedTaskId Double

(Integer) Specifies ID of a task which was retried if type is 'Retry'.

startTimeUsecs Double

(Integer) Specifies the time, as a Unix epoch timestamp in microseconds, when the task started execution.

status String

Constraints: Allowable values are: Scheduled, Running, Succeeded, Failed, PartiallyFailed, Canceled.

type String

Constraints: Allowable values are: Auto, Manual, Retry.

agents BackupRecoveryAgentUpgradeTaskAgent[]

(List) Specifies the upgrade information for each agent. Nested schema for agents:

clusterVersion string

(String) Specifies the version to which agents are upgraded.

endTimeUsecs number

(Integer) Specifies the time when the upgrade task completed execution as a Unix epoch Timestamp (in microseconds).

errors BackupRecoveryAgentUpgradeTaskError[]

(List) Object that holds the error object. Nested schema for error:

id string

The provider-assigned unique ID for this managed resource.

isRetryable boolean

(Boolean) Specifies if a task can be retried.

retriedTaskId number

(Integer) Specifies ID of a task which was retried if type is 'Retry'.

startTimeUsecs number

(Integer) Specifies the time, as a Unix epoch timestamp in microseconds, when the task started execution.

status string

Constraints: Allowable values are: Scheduled, Running, Succeeded, Failed, PartiallyFailed, Canceled.

type string

Constraints: Allowable values are: Auto, Manual, Retry.

agents Sequence[BackupRecoveryAgentUpgradeTaskAgent]

(List) Specifies the upgrade information for each agent. Nested schema for agents:

cluster_version str

(String) Specifies the version to which agents are upgraded.

end_time_usecs float

(Integer) Specifies the time when the upgrade task completed execution as a Unix epoch Timestamp (in microseconds).

errors Sequence[BackupRecoveryAgentUpgradeTaskError]

(List) Object that holds the error object. Nested schema for error:

id str

The provider-assigned unique ID for this managed resource.

is_retryable bool

(Boolean) Specifies if a task can be retried.

retried_task_id float

(Integer) Specifies ID of a task which was retried if type is 'Retry'.

start_time_usecs float

(Integer) Specifies the time, as a Unix epoch timestamp in microseconds, when the task started execution.

status str

Constraints: Allowable values are: Scheduled, Running, Succeeded, Failed, PartiallyFailed, Canceled.

type str

Constraints: Allowable values are: Auto, Manual, Retry.

agents List<Property Map>

(List) Specifies the upgrade information for each agent. Nested schema for agents:

clusterVersion String

(String) Specifies the version to which agents are upgraded.

endTimeUsecs Number

(Integer) Specifies the time when the upgrade task completed execution as a Unix epoch Timestamp (in microseconds).

errors List<Property Map>

(List) Object that holds the error object. Nested schema for error:

id String

The provider-assigned unique ID for this managed resource.

isRetryable Boolean

(Boolean) Specifies if a task can be retried.

retriedTaskId Number

(Integer) Specifies ID of a task which was retried if type is 'Retry'.

startTimeUsecs Number

(Integer) Specifies the time, as a Unix epoch timestamp in microseconds, when the task started execution.

status String

Constraints: Allowable values are: Scheduled, Running, Succeeded, Failed, PartiallyFailed, Canceled.

type String

Constraints: Allowable values are: Auto, Manual, Retry.

Look up Existing BackupRecoveryAgentUpgradeTask Resource

Get an existing BackupRecoveryAgentUpgradeTask resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: BackupRecoveryAgentUpgradeTaskState, opts?: CustomResourceOptions): BackupRecoveryAgentUpgradeTask

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        agent_ids: Optional[Sequence[float]] = None,
        agents: Optional[Sequence[BackupRecoveryAgentUpgradeTaskAgentArgs]] = None,
        backup_recovery_agent_upgrade_task_id: Optional[str] = None,
        cluster_version: Optional[str] = None,
        description: Optional[str] = None,
        end_time_usecs: Optional[float] = None,
        errors: Optional[Sequence[BackupRecoveryAgentUpgradeTaskErrorArgs]] = None,
        is_retryable: Optional[bool] = None,
        name: Optional[str] = None,
        retried_task_id: Optional[float] = None,
        retry_task_id: Optional[float] = None,
        schedule_end_time_usecs: Optional[float] = None,
        schedule_time_usecs: Optional[float] = None,
        start_time_usecs: Optional[float] = None,
        status: Optional[str] = None,
        type: Optional[str] = None,
        x_ibm_tenant_id: Optional[str] = None) -> BackupRecoveryAgentUpgradeTask

func GetBackupRecoveryAgentUpgradeTask(ctx *Context, name string, id IDInput, state *BackupRecoveryAgentUpgradeTaskState, opts ...ResourceOption) (*BackupRecoveryAgentUpgradeTask, error)

public static BackupRecoveryAgentUpgradeTask Get(string name, Input<string> id, BackupRecoveryAgentUpgradeTaskState? state, CustomResourceOptions? opts = null)

public static BackupRecoveryAgentUpgradeTask get(String name, Output<String> id, BackupRecoveryAgentUpgradeTaskState state, CustomResourceOptions options)

resources:  _:    type: ibm:BackupRecoveryAgentUpgradeTask    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AgentIds List<double>

Specifies the agents upgraded in the task.

Agents List<BackupRecoveryAgentUpgradeTaskAgent>

(List) Specifies the upgrade information for each agent. Nested schema for agents:

BackupRecoveryAgentUpgradeTaskId string

(Integer) Specifies the ID of the agent.

ClusterVersion string

(String) Specifies the version to which agents are upgraded.

Description string

Specifies the description of the task.

EndTimeUsecs double

(Integer) Specifies the time when the upgrade task completed execution as a Unix epoch Timestamp (in microseconds).

Errors List<BackupRecoveryAgentUpgradeTaskError>

(List) Object that holds the error object. Nested schema for error:

IsRetryable bool

(Boolean) Specifies if a task can be retried.

Name string

Specifies the name of the task.

RetriedTaskId double

(Integer) Specifies ID of a task which was retried if type is 'Retry'.

RetryTaskId double

Specifies ID of a task which is to be retried.

ScheduleEndTimeUsecs double

Specifies the time before which the upgrade task should start execution as a Unix epoch Timestamp (in microseconds). If this is not specified the task will start anytime after scheduleTimeUsecs.

ScheduleTimeUsecs double

Specifies the time when the task should start execution as a Unix epoch Timestamp (in microseconds). If no schedule is specified, the task will start immediately.

StartTimeUsecs double

(Integer) Specifies the time, as a Unix epoch timestamp in microseconds, when the task started execution.

Status string

Constraints: Allowable values are: Scheduled, Running, Succeeded, Failed, PartiallyFailed, Canceled.

Type string

Constraints: Allowable values are: Auto, Manual, Retry.

XIbmTenantId string

Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.

AgentIds []float64

Specifies the agents upgraded in the task.

Agents []BackupRecoveryAgentUpgradeTaskAgentArgs

(List) Specifies the upgrade information for each agent. Nested schema for agents:

BackupRecoveryAgentUpgradeTaskId string

(Integer) Specifies the ID of the agent.

ClusterVersion string

(String) Specifies the version to which agents are upgraded.

Description string

Specifies the description of the task.

EndTimeUsecs float64

(Integer) Specifies the time when the upgrade task completed execution as a Unix epoch Timestamp (in microseconds).

Errors []BackupRecoveryAgentUpgradeTaskErrorArgs

(List) Object that holds the error object. Nested schema for error:

IsRetryable bool

(Boolean) Specifies if a task can be retried.

Name string

Specifies the name of the task.

RetriedTaskId float64

(Integer) Specifies ID of a task which was retried if type is 'Retry'.

RetryTaskId float64

Specifies ID of a task which is to be retried.

ScheduleEndTimeUsecs float64

Specifies the time before which the upgrade task should start execution as a Unix epoch Timestamp (in microseconds). If this is not specified the task will start anytime after scheduleTimeUsecs.

ScheduleTimeUsecs float64

Specifies the time when the task should start execution as a Unix epoch Timestamp (in microseconds). If no schedule is specified, the task will start immediately.

StartTimeUsecs float64

(Integer) Specifies the time, as a Unix epoch timestamp in microseconds, when the task started execution.

Status string

Constraints: Allowable values are: Scheduled, Running, Succeeded, Failed, PartiallyFailed, Canceled.

Type string

Constraints: Allowable values are: Auto, Manual, Retry.

XIbmTenantId string

Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.

agentIds List<Double>

Specifies the agents upgraded in the task.

agents List<BackupRecoveryAgentUpgradeTaskAgent>

(List) Specifies the upgrade information for each agent. Nested schema for agents:

backupRecoveryAgentUpgradeTaskId String

(Integer) Specifies the ID of the agent.

clusterVersion String

(String) Specifies the version to which agents are upgraded.

description String

Specifies the description of the task.

endTimeUsecs Double

(Integer) Specifies the time when the upgrade task completed execution as a Unix epoch Timestamp (in microseconds).

errors List<BackupRecoveryAgentUpgradeTaskError>

(List) Object that holds the error object. Nested schema for error:

isRetryable Boolean

(Boolean) Specifies if a task can be retried.

name String

Specifies the name of the task.

retriedTaskId Double

(Integer) Specifies ID of a task which was retried if type is 'Retry'.

retryTaskId Double

Specifies ID of a task which is to be retried.

scheduleEndTimeUsecs Double

Specifies the time before which the upgrade task should start execution as a Unix epoch Timestamp (in microseconds). If this is not specified the task will start anytime after scheduleTimeUsecs.

scheduleTimeUsecs Double

Specifies the time when the task should start execution as a Unix epoch Timestamp (in microseconds). If no schedule is specified, the task will start immediately.

startTimeUsecs Double

(Integer) Specifies the time, as a Unix epoch timestamp in microseconds, when the task started execution.

status String

Constraints: Allowable values are: Scheduled, Running, Succeeded, Failed, PartiallyFailed, Canceled.

type String

Constraints: Allowable values are: Auto, Manual, Retry.

xIbmTenantId String

Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.

agentIds number[]

Specifies the agents upgraded in the task.

agents BackupRecoveryAgentUpgradeTaskAgent[]

(List) Specifies the upgrade information for each agent. Nested schema for agents:

backupRecoveryAgentUpgradeTaskId string

(Integer) Specifies the ID of the agent.

clusterVersion string

(String) Specifies the version to which agents are upgraded.

description string

Specifies the description of the task.

endTimeUsecs number

(Integer) Specifies the time when the upgrade task completed execution as a Unix epoch Timestamp (in microseconds).

errors BackupRecoveryAgentUpgradeTaskError[]

(List) Object that holds the error object. Nested schema for error:

isRetryable boolean

(Boolean) Specifies if a task can be retried.

name string

Specifies the name of the task.

retriedTaskId number

(Integer) Specifies ID of a task which was retried if type is 'Retry'.

retryTaskId number

Specifies ID of a task which is to be retried.

scheduleEndTimeUsecs number

Specifies the time before which the upgrade task should start execution as a Unix epoch Timestamp (in microseconds). If this is not specified the task will start anytime after scheduleTimeUsecs.

scheduleTimeUsecs number

Specifies the time when the task should start execution as a Unix epoch Timestamp (in microseconds). If no schedule is specified, the task will start immediately.

startTimeUsecs number

(Integer) Specifies the time, as a Unix epoch timestamp in microseconds, when the task started execution.

status string

Constraints: Allowable values are: Scheduled, Running, Succeeded, Failed, PartiallyFailed, Canceled.

type string

Constraints: Allowable values are: Auto, Manual, Retry.

xIbmTenantId string

Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.

agent_ids Sequence[float]

Specifies the agents upgraded in the task.

agents Sequence[BackupRecoveryAgentUpgradeTaskAgentArgs]

(List) Specifies the upgrade information for each agent. Nested schema for agents:

backup_recovery_agent_upgrade_task_id str

(Integer) Specifies the ID of the agent.

cluster_version str

(String) Specifies the version to which agents are upgraded.

description str

Specifies the description of the task.

end_time_usecs float

(Integer) Specifies the time when the upgrade task completed execution as a Unix epoch Timestamp (in microseconds).

errors Sequence[BackupRecoveryAgentUpgradeTaskErrorArgs]

(List) Object that holds the error object. Nested schema for error:

is_retryable bool

(Boolean) Specifies if a task can be retried.

name str

Specifies the name of the task.

retried_task_id float

(Integer) Specifies ID of a task which was retried if type is 'Retry'.

retry_task_id float

Specifies ID of a task which is to be retried.

schedule_end_time_usecs float

Specifies the time before which the upgrade task should start execution as a Unix epoch Timestamp (in microseconds). If this is not specified the task will start anytime after scheduleTimeUsecs.

schedule_time_usecs float

Specifies the time when the task should start execution as a Unix epoch Timestamp (in microseconds). If no schedule is specified, the task will start immediately.

start_time_usecs float

(Integer) Specifies the time, as a Unix epoch timestamp in microseconds, when the task started execution.

status str

Constraints: Allowable values are: Scheduled, Running, Succeeded, Failed, PartiallyFailed, Canceled.

type str

Constraints: Allowable values are: Auto, Manual, Retry.

x_ibm_tenant_id str

Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.

agentIds List<Number>

Specifies the agents upgraded in the task.

agents List<Property Map>

(List) Specifies the upgrade information for each agent. Nested schema for agents:

backupRecoveryAgentUpgradeTaskId String

(Integer) Specifies the ID of the agent.

clusterVersion String

(String) Specifies the version to which agents are upgraded.

description String

Specifies the description of the task.

endTimeUsecs Number

(Integer) Specifies the time when the upgrade task completed execution as a Unix epoch Timestamp (in microseconds).

errors List<Property Map>

(List) Object that holds the error object. Nested schema for error:

isRetryable Boolean

(Boolean) Specifies if a task can be retried.

name String

Specifies the name of the task.

retriedTaskId Number

(Integer) Specifies ID of a task which was retried if type is 'Retry'.

retryTaskId Number

Specifies ID of a task which is to be retried.

scheduleEndTimeUsecs Number

Specifies the time before which the upgrade task should start execution as a Unix epoch Timestamp (in microseconds). If this is not specified the task will start anytime after scheduleTimeUsecs.

scheduleTimeUsecs Number

Specifies the time when the task should start execution as a Unix epoch Timestamp (in microseconds). If no schedule is specified, the task will start immediately.

startTimeUsecs Number

(Integer) Specifies the time, as a Unix epoch timestamp in microseconds, when the task started execution.

status String

Constraints: Allowable values are: Scheduled, Running, Succeeded, Failed, PartiallyFailed, Canceled.

type String

Constraints: Allowable values are: Auto, Manual, Retry.

xIbmTenantId String

Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.

Supporting Types

BackupRecoveryAgentUpgradeTaskAgent, BackupRecoveryAgentUpgradeTaskAgentArgs

Id double: (Integer) Specifies the ID of the agent.
Infos List<BackupRecoveryAgentUpgradeTaskAgentInfo>: (List) Specifies the upgrade state of the agent. Nested schema for info:

Id float64: (Integer) Specifies the ID of the agent.
Infos []BackupRecoveryAgentUpgradeTaskAgentInfo: (List) Specifies the upgrade state of the agent. Nested schema for info:

id Double: (Integer) Specifies the ID of the agent.
infos List<BackupRecoveryAgentUpgradeTaskAgentInfo>: (List) Specifies the upgrade state of the agent. Nested schema for info:

id number: (Integer) Specifies the ID of the agent.
infos BackupRecoveryAgentUpgradeTaskAgentInfo[]: (List) Specifies the upgrade state of the agent. Nested schema for info:

id float: (Integer) Specifies the ID of the agent.
infos Sequence[BackupRecoveryAgentUpgradeTaskAgentInfo]: (List) Specifies the upgrade state of the agent. Nested schema for info:

id Number: (Integer) Specifies the ID of the agent.
infos List<Property Map>: (List) Specifies the upgrade state of the agent. Nested schema for info:

BackupRecoveryAgentUpgradeTaskAgentInfo, BackupRecoveryAgentUpgradeTaskAgentInfoArgs

EndTimeUsecs double

(Integer) Specifies the time when the upgrade task completed execution as a Unix epoch Timestamp (in microseconds).

Errors List<BackupRecoveryAgentUpgradeTaskAgentInfoError>

(List) Object that holds the error object. Nested schema for error:

Name string

Specifies the name of the task.

PreviousSoftwareVersion string

(String) Specifies the software version of the agent before upgrade.

StartTimeUsecs double

(Integer) Specifies the time, as a Unix epoch timestamp in microseconds, when the task started execution.

Status string

Constraints: Allowable values are: Scheduled, Running, Succeeded, Failed, PartiallyFailed, Canceled.

EndTimeUsecs float64

(Integer) Specifies the time when the upgrade task completed execution as a Unix epoch Timestamp (in microseconds).

Errors []BackupRecoveryAgentUpgradeTaskAgentInfoError

(List) Object that holds the error object. Nested schema for error:

Name string

Specifies the name of the task.

PreviousSoftwareVersion string

(String) Specifies the software version of the agent before upgrade.

StartTimeUsecs float64

(Integer) Specifies the time, as a Unix epoch timestamp in microseconds, when the task started execution.

Status string

Constraints: Allowable values are: Scheduled, Running, Succeeded, Failed, PartiallyFailed, Canceled.

endTimeUsecs Double

(Integer) Specifies the time when the upgrade task completed execution as a Unix epoch Timestamp (in microseconds).

errors List<BackupRecoveryAgentUpgradeTaskAgentInfoError>

(List) Object that holds the error object. Nested schema for error:

name String

Specifies the name of the task.

previousSoftwareVersion String

(String) Specifies the software version of the agent before upgrade.

startTimeUsecs Double

(Integer) Specifies the time, as a Unix epoch timestamp in microseconds, when the task started execution.

status String

Constraints: Allowable values are: Scheduled, Running, Succeeded, Failed, PartiallyFailed, Canceled.

endTimeUsecs number

(Integer) Specifies the time when the upgrade task completed execution as a Unix epoch Timestamp (in microseconds).

errors BackupRecoveryAgentUpgradeTaskAgentInfoError[]

(List) Object that holds the error object. Nested schema for error:

name string

Specifies the name of the task.

previousSoftwareVersion string

(String) Specifies the software version of the agent before upgrade.

startTimeUsecs number

(Integer) Specifies the time, as a Unix epoch timestamp in microseconds, when the task started execution.

status string

Constraints: Allowable values are: Scheduled, Running, Succeeded, Failed, PartiallyFailed, Canceled.

end_time_usecs float

(Integer) Specifies the time when the upgrade task completed execution as a Unix epoch Timestamp (in microseconds).

errors Sequence[BackupRecoveryAgentUpgradeTaskAgentInfoError]

(List) Object that holds the error object. Nested schema for error:

name str

Specifies the name of the task.

previous_software_version str

(String) Specifies the software version of the agent before upgrade.

start_time_usecs float

(Integer) Specifies the time, as a Unix epoch timestamp in microseconds, when the task started execution.

status str

Constraints: Allowable values are: Scheduled, Running, Succeeded, Failed, PartiallyFailed, Canceled.

endTimeUsecs Number

(Integer) Specifies the time when the upgrade task completed execution as a Unix epoch Timestamp (in microseconds).

errors List<Property Map>

(List) Object that holds the error object. Nested schema for error:

name String

Specifies the name of the task.

previousSoftwareVersion String

(String) Specifies the software version of the agent before upgrade.

startTimeUsecs Number

(Integer) Specifies the time, as a Unix epoch timestamp in microseconds, when the task started execution.

status String

Constraints: Allowable values are: Scheduled, Running, Succeeded, Failed, PartiallyFailed, Canceled.

BackupRecoveryAgentUpgradeTaskAgentInfoError, BackupRecoveryAgentUpgradeTaskAgentInfoErrorArgs

ErrorCode string: (String) Specifies the error code.
Message string: (String) Specifies the error message.
TaskLogId string: (String) Specifies the TaskLogId of the failed task.

ErrorCode string: (String) Specifies the error code.
Message string: (String) Specifies the error message.
TaskLogId string: (String) Specifies the TaskLogId of the failed task.

errorCode String: (String) Specifies the error code.
message String: (String) Specifies the error message.
taskLogId String: (String) Specifies the TaskLogId of the failed task.

errorCode string: (String) Specifies the error code.
message string: (String) Specifies the error message.
taskLogId string: (String) Specifies the TaskLogId of the failed task.

error_code str: (String) Specifies the error code.
message str: (String) Specifies the error message.
task_log_id str: (String) Specifies the TaskLogId of the failed task.

errorCode String: (String) Specifies the error code.
message String: (String) Specifies the error message.
taskLogId String: (String) Specifies the TaskLogId of the failed task.

BackupRecoveryAgentUpgradeTaskError, BackupRecoveryAgentUpgradeTaskErrorArgs

ErrorCode string: (String) Specifies the error code.
Message string: (String) Specifies the error message.
TaskLogId string: (String) Specifies the TaskLogId of the failed task.

ErrorCode string: (String) Specifies the error code.
Message string: (String) Specifies the error message.
TaskLogId string: (String) Specifies the TaskLogId of the failed task.

errorCode String: (String) Specifies the error code.
message String: (String) Specifies the error message.
taskLogId String: (String) Specifies the TaskLogId of the failed task.

errorCode string: (String) Specifies the error code.
message string: (String) Specifies the error message.
taskLogId string: (String) Specifies the TaskLogId of the failed task.

error_code str: (String) Specifies the error code.
message str: (String) Specifies the error message.
task_log_id str: (String) Specifies the TaskLogId of the failed task.

errorCode String: (String) Specifies the error code.
message String: (String) Specifies the error message.
taskLogId String: (String) Specifies the TaskLogId of the failed task.

Package Details

Repository: ibm ibm-cloud/terraform-provider-ibm
License
Notes: This Pulumi package is based on the ibm Terraform Provider.

ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm-cloud/terraform-provider-ibm

ibm.BackupRecoveryAgentUpgradeTask

On this page

On this page

Example Usage

Create BackupRecoveryAgentUpgradeTask Resource

Constructor syntax

Parameters

Constructor example

BackupRecoveryAgentUpgradeTask Resource Properties

Inputs

Outputs

Look up Existing BackupRecoveryAgentUpgradeTask Resource

Supporting Types

BackupRecoveryAgentUpgradeTaskAgent, BackupRecoveryAgentUpgradeTaskAgentArgs

BackupRecoveryAgentUpgradeTaskAgentInfo, BackupRecoveryAgentUpgradeTaskAgentInfoArgs

BackupRecoveryAgentUpgradeTaskAgentInfoError, BackupRecoveryAgentUpgradeTaskAgentInfoErrorArgs

BackupRecoveryAgentUpgradeTaskError, BackupRecoveryAgentUpgradeTaskErrorArgs

Package Details

On this page

On this page