Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Ibm Provider
  4. API Docs
  5. getBackupRecoveryConnectorAgents
Viewing docs for ibm 2.5.0
published on Wednesday, Aug 5, 2026 by ibm-cloud
Schema (JSON)
ibm-cloud/terraform-provider-ibm

ibm.getBackupRecoveryConnectorAgents

Viewing docs for ibm 2.5.0
published on Wednesday, Aug 5, 2026 by ibm-cloud
Schema (JSON)
ibm-cloud/terraform-provider-ibm

    Provides a read-only data source to retrieve information about backup_recovery_connector_agents. You can then reference the fields of the data source in other resources within the same configuration by using interpolation syntax.

    Example Usage

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

const backupRecoveryConnectorAgents = ibm.getBackupRecoveryConnectorAgents({
    tenantId: "tenant_id",
});

    import pulumi
import pulumi_ibm as ibm

backup_recovery_connector_agents = ibm.get_backup_recovery_connector_agents(tenant_id="tenant_id")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.GetBackupRecoveryConnectorAgents(ctx, &ibm.GetBackupRecoveryConnectorAgentsArgs{
			TenantId: "tenant_id",
		}, nil)
		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 backupRecoveryConnectorAgents = Ibm.GetBackupRecoveryConnectorAgents.Invoke(new()
    {
        TenantId = "tenant_id",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetBackupRecoveryConnectorAgentsArgs;
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) {
        final var backupRecoveryConnectorAgents = IbmFunctions.getBackupRecoveryConnectorAgents(GetBackupRecoveryConnectorAgentsArgs.builder()
            .tenantId("tenant_id")
            .build());

    }
}

    variables:
  backupRecoveryConnectorAgents:
    fn::invoke:
      function: ibm:getBackupRecoveryConnectorAgents
      arguments:
        tenantId: tenant_id

    Example coming soon!

    Using getBackupRecoveryConnectorAgents

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getBackupRecoveryConnectorAgents(args: GetBackupRecoveryConnectorAgentsArgs, opts?: InvokeOptions): Promise<GetBackupRecoveryConnectorAgentsResult>
function getBackupRecoveryConnectorAgentsOutput(args: GetBackupRecoveryConnectorAgentsOutputArgs, opts?: InvokeOptions): Output<GetBackupRecoveryConnectorAgentsResult>
    def get_backup_recovery_connector_agents(connection_ids: Optional[Sequence[float]] = None,
                                         connection_names: Optional[Sequence[str]] = None,
                                         endpoint_type: Optional[str] = None,
                                         id: Optional[str] = None,
                                         instance_id: Optional[str] = None,
                                         region: Optional[str] = None,
                                         service_name: Optional[str] = None,
                                         tenant_id: Optional[str] = None,
                                         x_ibm_tenant_id: Optional[str] = None,
                                         opts: Optional[InvokeOptions] = None) -> GetBackupRecoveryConnectorAgentsResult
def get_backup_recovery_connector_agents_output(connection_ids: pulumi.Input[Optional[Sequence[pulumi.Input[float]]]] = None,
                                         connection_names: pulumi.Input[Optional[Sequence[pulumi.Input[str]]]] = None,
                                         endpoint_type: pulumi.Input[Optional[str]] = None,
                                         id: pulumi.Input[Optional[str]] = None,
                                         instance_id: pulumi.Input[Optional[str]] = None,
                                         region: pulumi.Input[Optional[str]] = None,
                                         service_name: pulumi.Input[Optional[str]] = None,
                                         tenant_id: pulumi.Input[Optional[str]] = None,
                                         x_ibm_tenant_id: pulumi.Input[Optional[str]] = None,
                                         opts: Optional[InvokeOptions] = None) -> Output[GetBackupRecoveryConnectorAgentsResult]
    func GetBackupRecoveryConnectorAgents(ctx *Context, args *GetBackupRecoveryConnectorAgentsArgs, opts ...InvokeOption) (*GetBackupRecoveryConnectorAgentsResult, error)
func GetBackupRecoveryConnectorAgentsOutput(ctx *Context, args *GetBackupRecoveryConnectorAgentsOutputArgs, opts ...InvokeOption) GetBackupRecoveryConnectorAgentsResultOutput

    > Note: This function is named GetBackupRecoveryConnectorAgents in the Go SDK.

    public static class GetBackupRecoveryConnectorAgents 
{
    public static Task<GetBackupRecoveryConnectorAgentsResult> InvokeAsync(GetBackupRecoveryConnectorAgentsArgs args, InvokeOptions? opts = null)
    public static Output<GetBackupRecoveryConnectorAgentsResult> Invoke(GetBackupRecoveryConnectorAgentsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetBackupRecoveryConnectorAgentsResult> getBackupRecoveryConnectorAgents(GetBackupRecoveryConnectorAgentsArgs args, InvokeOptions options)
public static Output<GetBackupRecoveryConnectorAgentsResult> getBackupRecoveryConnectorAgents(GetBackupRecoveryConnectorAgentsArgs args, InvokeOptions options)

    fn::invoke:
  function: ibm:index/getBackupRecoveryConnectorAgents:getBackupRecoveryConnectorAgents
  arguments:
    # arguments dictionary
    data "ibm_get_backup_recovery_connector_agents" "name" {
    # arguments
}

    The following arguments are supported:

    TenantId string
    Specifies the ID of the tenant for which the connector agents are to be fetched.
    XIbmTenantId string
    Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
    ConnectionIds List<double>
    Specifies the connection IDs whose connector agents are to be fetched.
    ConnectionNames List<string>
    Specifies the connection names whose connector agents are to be fetched.
    EndpointType string
    Id string
    The unique identifier of the backup_recovery_connector_agents.
    InstanceId string
    Region string
    ServiceName string
    TenantId string
    Specifies the ID of the tenant for which the connector agents are to be fetched.
    XIbmTenantId string
    Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
    ConnectionIds []float64
    Specifies the connection IDs whose connector agents are to be fetched.
    ConnectionNames []string
    Specifies the connection names whose connector agents are to be fetched.
    EndpointType string
    Id string
    The unique identifier of the backup_recovery_connector_agents.
    InstanceId string
    Region string
    ServiceName string
    tenant_id string
    Specifies the ID of the tenant for which the connector agents are to be fetched.
    x_ibm_tenant_id string
    Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
    connection_ids list(number)
    Specifies the connection IDs whose connector agents are to be fetched.
    connection_names list(string)
    Specifies the connection names whose connector agents are to be fetched.
    endpoint_type string
    id string
    The unique identifier of the backup_recovery_connector_agents.
    instance_id string
    region string
    service_name string
    tenantId String
    Specifies the ID of the tenant for which the connector agents are to be fetched.
    xIbmTenantId String
    Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
    connectionIds List<Double>
    Specifies the connection IDs whose connector agents are to be fetched.
    connectionNames List<String>
    Specifies the connection names whose connector agents are to be fetched.
    endpointType String
    id String
    The unique identifier of the backup_recovery_connector_agents.
    instanceId String
    region String
    serviceName String
    tenantId string
    Specifies the ID of the tenant for which the connector agents are to be fetched.
    xIbmTenantId string
    Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
    connectionIds number[]
    Specifies the connection IDs whose connector agents are to be fetched.
    connectionNames string[]
    Specifies the connection names whose connector agents are to be fetched.
    endpointType string
    id string
    The unique identifier of the backup_recovery_connector_agents.
    instanceId string
    region string
    serviceName string
    tenant_id str
    Specifies the ID of the tenant for which the connector agents are to be fetched.
    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.
    connection_ids Sequence[float]
    Specifies the connection IDs whose connector agents are to be fetched.
    connection_names Sequence[str]
    Specifies the connection names whose connector agents are to be fetched.
    endpoint_type str
    id str
    The unique identifier of the backup_recovery_connector_agents.
    instance_id str
    region str
    service_name str
    tenantId String
    Specifies the ID of the tenant for which the connector agents are to be fetched.
    xIbmTenantId String
    Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
    connectionIds List<Number>
    Specifies the connection IDs whose connector agents are to be fetched.
    connectionNames List<String>
    Specifies the connection names whose connector agents are to be fetched.
    endpointType String
    id String
    The unique identifier of the backup_recovery_connector_agents.
    instanceId String
    region String
    serviceName String

    getBackupRecoveryConnectorAgents Result

    The following output properties are available:

    ConnectorAgents List<GetBackupRecoveryConnectorAgentsConnectorAgent>
    (List) Nested schema for connector_agents:
    Id string
    The unique identifier of the backup_recovery_connector_agents.
    Region string
    TenantId string
    XIbmTenantId string
    ConnectionIds List<double>
    ConnectionNames List<string>
    EndpointType string
    InstanceId string
    ServiceName string
    ConnectorAgents []GetBackupRecoveryConnectorAgentsConnectorAgent
    (List) Nested schema for connector_agents:
    Id string
    The unique identifier of the backup_recovery_connector_agents.
    Region string
    TenantId string
    XIbmTenantId string
    ConnectionIds []float64
    ConnectionNames []string
    EndpointType string
    InstanceId string
    ServiceName string
    connector_agents list(object)
    (List) Nested schema for connector_agents:
    id string
    The unique identifier of the backup_recovery_connector_agents.
    region string
    tenant_id string
    x_ibm_tenant_id string
    connection_ids list(number)
    connection_names list(string)
    endpoint_type string
    instance_id string
    service_name string
    connectorAgents List<GetBackupRecoveryConnectorAgentsConnectorAgent>
    (List) Nested schema for connector_agents:
    id String
    The unique identifier of the backup_recovery_connector_agents.
    region String
    tenantId String
    xIbmTenantId String
    connectionIds List<Double>
    connectionNames List<String>
    endpointType String
    instanceId String
    serviceName String
    connectorAgents GetBackupRecoveryConnectorAgentsConnectorAgent[]
    (List) Nested schema for connector_agents:
    id string
    The unique identifier of the backup_recovery_connector_agents.
    region string
    tenantId string
    xIbmTenantId string
    connectionIds number[]
    connectionNames string[]
    endpointType string
    instanceId string
    serviceName string
    connector_agents Sequence[GetBackupRecoveryConnectorAgentsConnectorAgent]
    (List) Nested schema for connector_agents:
    id str
    The unique identifier of the backup_recovery_connector_agents.
    region str
    tenant_id str
    x_ibm_tenant_id str
    connection_ids Sequence[float]
    connection_names Sequence[str]
    endpoint_type str
    instance_id str
    service_name str
    connectorAgents List<Property Map>
    (List) Nested schema for connector_agents:
    id String
    The unique identifier of the backup_recovery_connector_agents.
    region String
    tenantId String
    xIbmTenantId String
    connectionIds List<Number>
    connectionNames List<String>
    endpointType String
    instanceId String
    serviceName String

    Supporting Types

    GetBackupRecoveryConnectorAgentsConnectorAgent

    ConnectionId string
    (String) Specifies the ID of the connection to which this connector agent belongs.
    ConnectionName string
    (String) Specifies the name of the connection to which this connector agent belongs.
    ConnectivityStatuses List<GetBackupRecoveryConnectorAgentsConnectorAgentConnectivityStatus>
    (List) Specifies connector agent connectivity statusinformation like current connectivity status to cluster,when it last connected to the cluster successfully and fromwhen it has been continuously connected to the cluster without anyinterruptions. Nested schema for connectivity_status:
    ConnectorAgentId string
    (String) Specifies the unique ID of the connector agent.
    ConnectorAgentName string
    (String) Specifies the name of the connector agent.
    SoftwareVersion string
    (String) Specifies the connector agent's software version.
    ConnectionId string
    (String) Specifies the ID of the connection to which this connector agent belongs.
    ConnectionName string
    (String) Specifies the name of the connection to which this connector agent belongs.
    ConnectivityStatuses []GetBackupRecoveryConnectorAgentsConnectorAgentConnectivityStatus
    (List) Specifies connector agent connectivity statusinformation like current connectivity status to cluster,when it last connected to the cluster successfully and fromwhen it has been continuously connected to the cluster without anyinterruptions. Nested schema for connectivity_status:
    ConnectorAgentId string
    (String) Specifies the unique ID of the connector agent.
    ConnectorAgentName string
    (String) Specifies the name of the connector agent.
    SoftwareVersion string
    (String) Specifies the connector agent's software version.
    connection_id string
    (String) Specifies the ID of the connection to which this connector agent belongs.
    connection_name string
    (String) Specifies the name of the connection to which this connector agent belongs.
    connectivity_statuses list(object)
    (List) Specifies connector agent connectivity statusinformation like current connectivity status to cluster,when it last connected to the cluster successfully and fromwhen it has been continuously connected to the cluster without anyinterruptions. Nested schema for connectivity_status:
    connector_agent_id string
    (String) Specifies the unique ID of the connector agent.
    connector_agent_name string
    (String) Specifies the name of the connector agent.
    software_version string
    (String) Specifies the connector agent's software version.
    connectionId String
    (String) Specifies the ID of the connection to which this connector agent belongs.
    connectionName String
    (String) Specifies the name of the connection to which this connector agent belongs.
    connectivityStatuses List<GetBackupRecoveryConnectorAgentsConnectorAgentConnectivityStatus>
    (List) Specifies connector agent connectivity statusinformation like current connectivity status to cluster,when it last connected to the cluster successfully and fromwhen it has been continuously connected to the cluster without anyinterruptions. Nested schema for connectivity_status:
    connectorAgentId String
    (String) Specifies the unique ID of the connector agent.
    connectorAgentName String
    (String) Specifies the name of the connector agent.
    softwareVersion String
    (String) Specifies the connector agent's software version.
    connectionId string
    (String) Specifies the ID of the connection to which this connector agent belongs.
    connectionName string
    (String) Specifies the name of the connection to which this connector agent belongs.
    connectivityStatuses GetBackupRecoveryConnectorAgentsConnectorAgentConnectivityStatus[]
    (List) Specifies connector agent connectivity statusinformation like current connectivity status to cluster,when it last connected to the cluster successfully and fromwhen it has been continuously connected to the cluster without anyinterruptions. Nested schema for connectivity_status:
    connectorAgentId string
    (String) Specifies the unique ID of the connector agent.
    connectorAgentName string
    (String) Specifies the name of the connector agent.
    softwareVersion string
    (String) Specifies the connector agent's software version.
    connection_id str
    (String) Specifies the ID of the connection to which this connector agent belongs.
    connection_name str
    (String) Specifies the name of the connection to which this connector agent belongs.
    connectivity_statuses Sequence[GetBackupRecoveryConnectorAgentsConnectorAgentConnectivityStatus]
    (List) Specifies connector agent connectivity statusinformation like current connectivity status to cluster,when it last connected to the cluster successfully and fromwhen it has been continuously connected to the cluster without anyinterruptions. Nested schema for connectivity_status:
    connector_agent_id str
    (String) Specifies the unique ID of the connector agent.
    connector_agent_name str
    (String) Specifies the name of the connector agent.
    software_version str
    (String) Specifies the connector agent's software version.
    connectionId String
    (String) Specifies the ID of the connection to which this connector agent belongs.
    connectionName String
    (String) Specifies the name of the connection to which this connector agent belongs.
    connectivityStatuses List<Property Map>
    (List) Specifies connector agent connectivity statusinformation like current connectivity status to cluster,when it last connected to the cluster successfully and fromwhen it has been continuously connected to the cluster without anyinterruptions. Nested schema for connectivity_status:
    connectorAgentId String
    (String) Specifies the unique ID of the connector agent.
    connectorAgentName String
    (String) Specifies the name of the connector agent.
    softwareVersion String
    (String) Specifies the connector agent's software version.

    GetBackupRecoveryConnectorAgentsConnectorAgentConnectivityStatus

    ConnectedSinceTimestampSecs double
    (Integer) This denotes the timestamp in UNIX seconds since when this connector agent has been connected to its cluster without any interruptions. This property will not be present if this connector agent is not currently connected to its cluster.
    IsConnected bool
    (Boolean) Specifies whether the connector agent is currently connected to the cluster.
    LastKnownHealthOkTimestampSecs double
    (Integer) Specifies the most recent known timestamp in UNIX seconds at which this connector agent passed the health checks. This property can be present even if this connector agent is not currently connected to its cluster.
    Message string
    (String) Specifies error message when the connector agent is unable to connect to the cluster.
    ConnectedSinceTimestampSecs float64
    (Integer) This denotes the timestamp in UNIX seconds since when this connector agent has been connected to its cluster without any interruptions. This property will not be present if this connector agent is not currently connected to its cluster.
    IsConnected bool
    (Boolean) Specifies whether the connector agent is currently connected to the cluster.
    LastKnownHealthOkTimestampSecs float64
    (Integer) Specifies the most recent known timestamp in UNIX seconds at which this connector agent passed the health checks. This property can be present even if this connector agent is not currently connected to its cluster.
    Message string
    (String) Specifies error message when the connector agent is unable to connect to the cluster.
    connected_since_timestamp_secs number
    (Integer) This denotes the timestamp in UNIX seconds since when this connector agent has been connected to its cluster without any interruptions. This property will not be present if this connector agent is not currently connected to its cluster.
    is_connected bool
    (Boolean) Specifies whether the connector agent is currently connected to the cluster.
    last_known_health_ok_timestamp_secs number
    (Integer) Specifies the most recent known timestamp in UNIX seconds at which this connector agent passed the health checks. This property can be present even if this connector agent is not currently connected to its cluster.
    message string
    (String) Specifies error message when the connector agent is unable to connect to the cluster.
    connectedSinceTimestampSecs Double
    (Integer) This denotes the timestamp in UNIX seconds since when this connector agent has been connected to its cluster without any interruptions. This property will not be present if this connector agent is not currently connected to its cluster.
    isConnected Boolean
    (Boolean) Specifies whether the connector agent is currently connected to the cluster.
    lastKnownHealthOkTimestampSecs Double
    (Integer) Specifies the most recent known timestamp in UNIX seconds at which this connector agent passed the health checks. This property can be present even if this connector agent is not currently connected to its cluster.
    message String
    (String) Specifies error message when the connector agent is unable to connect to the cluster.
    connectedSinceTimestampSecs number
    (Integer) This denotes the timestamp in UNIX seconds since when this connector agent has been connected to its cluster without any interruptions. This property will not be present if this connector agent is not currently connected to its cluster.
    isConnected boolean
    (Boolean) Specifies whether the connector agent is currently connected to the cluster.
    lastKnownHealthOkTimestampSecs number
    (Integer) Specifies the most recent known timestamp in UNIX seconds at which this connector agent passed the health checks. This property can be present even if this connector agent is not currently connected to its cluster.
    message string
    (String) Specifies error message when the connector agent is unable to connect to the cluster.
    connected_since_timestamp_secs float
    (Integer) This denotes the timestamp in UNIX seconds since when this connector agent has been connected to its cluster without any interruptions. This property will not be present if this connector agent is not currently connected to its cluster.
    is_connected bool
    (Boolean) Specifies whether the connector agent is currently connected to the cluster.
    last_known_health_ok_timestamp_secs float
    (Integer) Specifies the most recent known timestamp in UNIX seconds at which this connector agent passed the health checks. This property can be present even if this connector agent is not currently connected to its cluster.
    message str
    (String) Specifies error message when the connector agent is unable to connect to the cluster.
    connectedSinceTimestampSecs Number
    (Integer) This denotes the timestamp in UNIX seconds since when this connector agent has been connected to its cluster without any interruptions. This property will not be present if this connector agent is not currently connected to its cluster.
    isConnected Boolean
    (Boolean) Specifies whether the connector agent is currently connected to the cluster.
    lastKnownHealthOkTimestampSecs Number
    (Integer) Specifies the most recent known timestamp in UNIX seconds at which this connector agent passed the health checks. This property can be present even if this connector agent is not currently connected to its cluster.
    message String
    (String) Specifies error message when the connector agent is unable to connect to the cluster.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    Viewing docs for ibm 2.5.0
    published on Wednesday, Aug 5, 2026 by ibm-cloud
    Schema (JSON)
    ibm-cloud/terraform-provider-ibm

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial