1. Packages
  2. Ibm Provider
  3. API Docs
  4. getBackupRecoveryDataSourceConnectors
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.getBackupRecoveryDataSourceConnectors

Explore with Pulumi AI

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

    Provides a read-only data source to retrieve information about Data-Source Connectors. 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 backupRecoveryDataSourceConnectors = ibm.getBackupRecoveryDataSourceConnectors({
        xIbmTenantId: "x_ibm_tenant_id",
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    backup_recovery_data_source_connectors = ibm.get_backup_recovery_data_source_connectors(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.GetBackupRecoveryDataSourceConnectors(ctx, &ibm.GetBackupRecoveryDataSourceConnectorsArgs{
    			XIbmTenantId: "x_ibm_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 backupRecoveryDataSourceConnectors = Ibm.GetBackupRecoveryDataSourceConnectors.Invoke(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.IbmFunctions;
    import com.pulumi.ibm.inputs.GetBackupRecoveryDataSourceConnectorsArgs;
    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 backupRecoveryDataSourceConnectors = IbmFunctions.getBackupRecoveryDataSourceConnectors(GetBackupRecoveryDataSourceConnectorsArgs.builder()
                .xIbmTenantId("x_ibm_tenant_id")
                .build());
    
        }
    }
    
    variables:
      backupRecoveryDataSourceConnectors:
        fn::invoke:
          function: ibm:getBackupRecoveryDataSourceConnectors
          arguments:
            xIbmTenantId: x_ibm_tenant_id
    

    Using getBackupRecoveryDataSourceConnectors

    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 getBackupRecoveryDataSourceConnectors(args: GetBackupRecoveryDataSourceConnectorsArgs, opts?: InvokeOptions): Promise<GetBackupRecoveryDataSourceConnectorsResult>
    function getBackupRecoveryDataSourceConnectorsOutput(args: GetBackupRecoveryDataSourceConnectorsOutputArgs, opts?: InvokeOptions): Output<GetBackupRecoveryDataSourceConnectorsResult>
    def get_backup_recovery_data_source_connectors(connection_id: Optional[str] = None,
                                                   connector_ids: Optional[Sequence[str]] = None,
                                                   connector_names: Optional[Sequence[str]] = None,
                                                   id: Optional[str] = None,
                                                   x_ibm_tenant_id: Optional[str] = None,
                                                   opts: Optional[InvokeOptions] = None) -> GetBackupRecoveryDataSourceConnectorsResult
    def get_backup_recovery_data_source_connectors_output(connection_id: Optional[pulumi.Input[str]] = None,
                                                   connector_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                                                   connector_names: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                                                   id: Optional[pulumi.Input[str]] = None,
                                                   x_ibm_tenant_id: Optional[pulumi.Input[str]] = None,
                                                   opts: Optional[InvokeOptions] = None) -> Output[GetBackupRecoveryDataSourceConnectorsResult]
    func GetBackupRecoveryDataSourceConnectors(ctx *Context, args *GetBackupRecoveryDataSourceConnectorsArgs, opts ...InvokeOption) (*GetBackupRecoveryDataSourceConnectorsResult, error)
    func GetBackupRecoveryDataSourceConnectorsOutput(ctx *Context, args *GetBackupRecoveryDataSourceConnectorsOutputArgs, opts ...InvokeOption) GetBackupRecoveryDataSourceConnectorsResultOutput

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

    public static class GetBackupRecoveryDataSourceConnectors 
    {
        public static Task<GetBackupRecoveryDataSourceConnectorsResult> InvokeAsync(GetBackupRecoveryDataSourceConnectorsArgs args, InvokeOptions? opts = null)
        public static Output<GetBackupRecoveryDataSourceConnectorsResult> Invoke(GetBackupRecoveryDataSourceConnectorsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetBackupRecoveryDataSourceConnectorsResult> getBackupRecoveryDataSourceConnectors(GetBackupRecoveryDataSourceConnectorsArgs args, InvokeOptions options)
    public static Output<GetBackupRecoveryDataSourceConnectorsResult> getBackupRecoveryDataSourceConnectors(GetBackupRecoveryDataSourceConnectorsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getBackupRecoveryDataSourceConnectors:getBackupRecoveryDataSourceConnectors
      arguments:
        # arguments dictionary

    The following arguments are supported:

    XIbmTenantId string
    Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
    ConnectionId string
    Specifies the ID of the connection, connectors belonging to which are to be fetched.
    ConnectorIds List<string>
    Specifies the unique IDs of the connectors which are to be fetched.
    ConnectorNames List<string>
    Specifies the names of the connectors which are to be fetched.
    Id string
    The unique identifier of the Data-Source Connectors.
    XIbmTenantId string
    Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
    ConnectionId string
    Specifies the ID of the connection, connectors belonging to which are to be fetched.
    ConnectorIds []string
    Specifies the unique IDs of the connectors which are to be fetched.
    ConnectorNames []string
    Specifies the names of the connectors which are to be fetched.
    Id string
    The unique identifier of the Data-Source Connectors.
    xIbmTenantId String
    Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
    connectionId String
    Specifies the ID of the connection, connectors belonging to which are to be fetched.
    connectorIds List<String>
    Specifies the unique IDs of the connectors which are to be fetched.
    connectorNames List<String>
    Specifies the names of the connectors which are to be fetched.
    id String
    The unique identifier of the Data-Source Connectors.
    xIbmTenantId string
    Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
    connectionId string
    Specifies the ID of the connection, connectors belonging to which are to be fetched.
    connectorIds string[]
    Specifies the unique IDs of the connectors which are to be fetched.
    connectorNames string[]
    Specifies the names of the connectors which are to be fetched.
    id string
    The unique identifier of the Data-Source Connectors.
    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_id str
    Specifies the ID of the connection, connectors belonging to which are to be fetched.
    connector_ids Sequence[str]
    Specifies the unique IDs of the connectors which are to be fetched.
    connector_names Sequence[str]
    Specifies the names of the connectors which are to be fetched.
    id str
    The unique identifier of the Data-Source Connectors.
    xIbmTenantId String
    Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
    connectionId String
    Specifies the ID of the connection, connectors belonging to which are to be fetched.
    connectorIds List<String>
    Specifies the unique IDs of the connectors which are to be fetched.
    connectorNames List<String>
    Specifies the names of the connectors which are to be fetched.
    id String
    The unique identifier of the Data-Source Connectors.

    getBackupRecoveryDataSourceConnectors Result

    The following output properties are available:

    Connectors List<GetBackupRecoveryDataSourceConnectorsConnector>
    (List) Nested schema for connectors:
    Id string
    The unique identifier of the Data-Source Connectors.
    XIbmTenantId string
    ConnectionId string
    (String) Specifies the ID of the connection to which this connector belongs.
    ConnectorIds List<string>
    ConnectorNames List<string>
    Connectors []GetBackupRecoveryDataSourceConnectorsConnector
    (List) Nested schema for connectors:
    Id string
    The unique identifier of the Data-Source Connectors.
    XIbmTenantId string
    ConnectionId string
    (String) Specifies the ID of the connection to which this connector belongs.
    ConnectorIds []string
    ConnectorNames []string
    connectors List<GetBackupRecoveryDataSourceConnectorsConnector>
    (List) Nested schema for connectors:
    id String
    The unique identifier of the Data-Source Connectors.
    xIbmTenantId String
    connectionId String
    (String) Specifies the ID of the connection to which this connector belongs.
    connectorIds List<String>
    connectorNames List<String>
    connectors GetBackupRecoveryDataSourceConnectorsConnector[]
    (List) Nested schema for connectors:
    id string
    The unique identifier of the Data-Source Connectors.
    xIbmTenantId string
    connectionId string
    (String) Specifies the ID of the connection to which this connector belongs.
    connectorIds string[]
    connectorNames string[]
    connectors Sequence[GetBackupRecoveryDataSourceConnectorsConnector]
    (List) Nested schema for connectors:
    id str
    The unique identifier of the Data-Source Connectors.
    x_ibm_tenant_id str
    connection_id str
    (String) Specifies the ID of the connection to which this connector belongs.
    connector_ids Sequence[str]
    connector_names Sequence[str]
    connectors List<Property Map>
    (List) Nested schema for connectors:
    id String
    The unique identifier of the Data-Source Connectors.
    xIbmTenantId String
    connectionId String
    (String) Specifies the ID of the connection to which this connector belongs.
    connectorIds List<String>
    connectorNames List<String>

    Supporting Types

    GetBackupRecoveryDataSourceConnectorsConnector

    ClusterSideIp string
    (String) Specifies the IP of the connector's NIC facing the cluster.
    ConnectionId string
    Specifies the ID of the connection, connectors belonging to which are to be fetched.
    ConnectivityStatuses List<GetBackupRecoveryDataSourceConnectorsConnectorConnectivityStatus>
    (List) Specifies status information for the data-source connector. For example if it's currently connected to the cluster, when it last connected to the cluster successfully, etc. Nested schema for connectivity_status:
    ConnectorId string
    (String) Specifies the unique ID of the connector.
    ConnectorName string
    (String) Specifies the name of the connector. The name of a connector need not be unique within a tenant or across tenants. The name of the connector can be updated as needed.
    SoftwareVersion string
    (String) Specifies the connector's software version.
    TenantSideIp string
    (String) Specifies the IP of the connector's NIC facing the sources of the tenant to which the connector belongs.
    UpgradeStatuses List<GetBackupRecoveryDataSourceConnectorsConnectorUpgradeStatus>
    (List) Specifies upgrade status for the data-source connector. For example when the upgrade started, current status of the upgrade, errors for upgrade failure etc. Nested schema for upgrade_status:
    ClusterSideIp string
    (String) Specifies the IP of the connector's NIC facing the cluster.
    ConnectionId string
    Specifies the ID of the connection, connectors belonging to which are to be fetched.
    ConnectivityStatuses []GetBackupRecoveryDataSourceConnectorsConnectorConnectivityStatus
    (List) Specifies status information for the data-source connector. For example if it's currently connected to the cluster, when it last connected to the cluster successfully, etc. Nested schema for connectivity_status:
    ConnectorId string
    (String) Specifies the unique ID of the connector.
    ConnectorName string
    (String) Specifies the name of the connector. The name of a connector need not be unique within a tenant or across tenants. The name of the connector can be updated as needed.
    SoftwareVersion string
    (String) Specifies the connector's software version.
    TenantSideIp string
    (String) Specifies the IP of the connector's NIC facing the sources of the tenant to which the connector belongs.
    UpgradeStatuses []GetBackupRecoveryDataSourceConnectorsConnectorUpgradeStatus
    (List) Specifies upgrade status for the data-source connector. For example when the upgrade started, current status of the upgrade, errors for upgrade failure etc. Nested schema for upgrade_status:
    clusterSideIp String
    (String) Specifies the IP of the connector's NIC facing the cluster.
    connectionId String
    Specifies the ID of the connection, connectors belonging to which are to be fetched.
    connectivityStatuses List<GetBackupRecoveryDataSourceConnectorsConnectorConnectivityStatus>
    (List) Specifies status information for the data-source connector. For example if it's currently connected to the cluster, when it last connected to the cluster successfully, etc. Nested schema for connectivity_status:
    connectorId String
    (String) Specifies the unique ID of the connector.
    connectorName String
    (String) Specifies the name of the connector. The name of a connector need not be unique within a tenant or across tenants. The name of the connector can be updated as needed.
    softwareVersion String
    (String) Specifies the connector's software version.
    tenantSideIp String
    (String) Specifies the IP of the connector's NIC facing the sources of the tenant to which the connector belongs.
    upgradeStatuses List<GetBackupRecoveryDataSourceConnectorsConnectorUpgradeStatus>
    (List) Specifies upgrade status for the data-source connector. For example when the upgrade started, current status of the upgrade, errors for upgrade failure etc. Nested schema for upgrade_status:
    clusterSideIp string
    (String) Specifies the IP of the connector's NIC facing the cluster.
    connectionId string
    Specifies the ID of the connection, connectors belonging to which are to be fetched.
    connectivityStatuses GetBackupRecoveryDataSourceConnectorsConnectorConnectivityStatus[]
    (List) Specifies status information for the data-source connector. For example if it's currently connected to the cluster, when it last connected to the cluster successfully, etc. Nested schema for connectivity_status:
    connectorId string
    (String) Specifies the unique ID of the connector.
    connectorName string
    (String) Specifies the name of the connector. The name of a connector need not be unique within a tenant or across tenants. The name of the connector can be updated as needed.
    softwareVersion string
    (String) Specifies the connector's software version.
    tenantSideIp string
    (String) Specifies the IP of the connector's NIC facing the sources of the tenant to which the connector belongs.
    upgradeStatuses GetBackupRecoveryDataSourceConnectorsConnectorUpgradeStatus[]
    (List) Specifies upgrade status for the data-source connector. For example when the upgrade started, current status of the upgrade, errors for upgrade failure etc. Nested schema for upgrade_status:
    cluster_side_ip str
    (String) Specifies the IP of the connector's NIC facing the cluster.
    connection_id str
    Specifies the ID of the connection, connectors belonging to which are to be fetched.
    connectivity_statuses Sequence[GetBackupRecoveryDataSourceConnectorsConnectorConnectivityStatus]
    (List) Specifies status information for the data-source connector. For example if it's currently connected to the cluster, when it last connected to the cluster successfully, etc. Nested schema for connectivity_status:
    connector_id str
    (String) Specifies the unique ID of the connector.
    connector_name str
    (String) Specifies the name of the connector. The name of a connector need not be unique within a tenant or across tenants. The name of the connector can be updated as needed.
    software_version str
    (String) Specifies the connector's software version.
    tenant_side_ip str
    (String) Specifies the IP of the connector's NIC facing the sources of the tenant to which the connector belongs.
    upgrade_statuses Sequence[GetBackupRecoveryDataSourceConnectorsConnectorUpgradeStatus]
    (List) Specifies upgrade status for the data-source connector. For example when the upgrade started, current status of the upgrade, errors for upgrade failure etc. Nested schema for upgrade_status:
    clusterSideIp String
    (String) Specifies the IP of the connector's NIC facing the cluster.
    connectionId String
    Specifies the ID of the connection, connectors belonging to which are to be fetched.
    connectivityStatuses List<Property Map>
    (List) Specifies status information for the data-source connector. For example if it's currently connected to the cluster, when it last connected to the cluster successfully, etc. Nested schema for connectivity_status:
    connectorId String
    (String) Specifies the unique ID of the connector.
    connectorName String
    (String) Specifies the name of the connector. The name of a connector need not be unique within a tenant or across tenants. The name of the connector can be updated as needed.
    softwareVersion String
    (String) Specifies the connector's software version.
    tenantSideIp String
    (String) Specifies the IP of the connector's NIC facing the sources of the tenant to which the connector belongs.
    upgradeStatuses List<Property Map>
    (List) Specifies upgrade status for the data-source connector. For example when the upgrade started, current status of the upgrade, errors for upgrade failure etc. Nested schema for upgrade_status:

    GetBackupRecoveryDataSourceConnectorsConnectorConnectivityStatus

    IsConnected bool
    (Boolean) Specifies whether the connector is currently connected to the cluster.
    LastConnectedTimestampSecs double
    (Integer) Specifies the last timestamp in UNIX time (seconds) when the connector had successfully connected to the cluster. This property can be present even if the connector is currently disconnected.
    Message string
    (String) Specifies error message for upgrade failure.
    IsConnected bool
    (Boolean) Specifies whether the connector is currently connected to the cluster.
    LastConnectedTimestampSecs float64
    (Integer) Specifies the last timestamp in UNIX time (seconds) when the connector had successfully connected to the cluster. This property can be present even if the connector is currently disconnected.
    Message string
    (String) Specifies error message for upgrade failure.
    isConnected Boolean
    (Boolean) Specifies whether the connector is currently connected to the cluster.
    lastConnectedTimestampSecs Double
    (Integer) Specifies the last timestamp in UNIX time (seconds) when the connector had successfully connected to the cluster. This property can be present even if the connector is currently disconnected.
    message String
    (String) Specifies error message for upgrade failure.
    isConnected boolean
    (Boolean) Specifies whether the connector is currently connected to the cluster.
    lastConnectedTimestampSecs number
    (Integer) Specifies the last timestamp in UNIX time (seconds) when the connector had successfully connected to the cluster. This property can be present even if the connector is currently disconnected.
    message string
    (String) Specifies error message for upgrade failure.
    is_connected bool
    (Boolean) Specifies whether the connector is currently connected to the cluster.
    last_connected_timestamp_secs float
    (Integer) Specifies the last timestamp in UNIX time (seconds) when the connector had successfully connected to the cluster. This property can be present even if the connector is currently disconnected.
    message str
    (String) Specifies error message for upgrade failure.
    isConnected Boolean
    (Boolean) Specifies whether the connector is currently connected to the cluster.
    lastConnectedTimestampSecs Number
    (Integer) Specifies the last timestamp in UNIX time (seconds) when the connector had successfully connected to the cluster. This property can be present even if the connector is currently disconnected.
    message String
    (String) Specifies error message for upgrade failure.

    GetBackupRecoveryDataSourceConnectorsConnectorUpgradeStatus

    LastStatusFetchedTimestampMsecs double
    (Integer) Specifies the last timestamp in UNIX time (milliseconds) when the connector upgrade status was fetched.
    Message string
    (String) Specifies error message for upgrade failure.
    StartTimestampMSecs double
    (Integer) Specifies the last timestamp in UNIX time (milliseconds) when the connector upgrade was triggered.
    Status string
    (String) Specifies the last fetched upgrade status of the connector.

    • Constraints: Allowable values are: NotStarted, InProgress, Succeeded, Failed.
    LastStatusFetchedTimestampMsecs float64
    (Integer) Specifies the last timestamp in UNIX time (milliseconds) when the connector upgrade status was fetched.
    Message string
    (String) Specifies error message for upgrade failure.
    StartTimestampMSecs float64
    (Integer) Specifies the last timestamp in UNIX time (milliseconds) when the connector upgrade was triggered.
    Status string
    (String) Specifies the last fetched upgrade status of the connector.

    • Constraints: Allowable values are: NotStarted, InProgress, Succeeded, Failed.
    lastStatusFetchedTimestampMsecs Double
    (Integer) Specifies the last timestamp in UNIX time (milliseconds) when the connector upgrade status was fetched.
    message String
    (String) Specifies error message for upgrade failure.
    startTimestampMSecs Double
    (Integer) Specifies the last timestamp in UNIX time (milliseconds) when the connector upgrade was triggered.
    status String
    (String) Specifies the last fetched upgrade status of the connector.

    • Constraints: Allowable values are: NotStarted, InProgress, Succeeded, Failed.
    lastStatusFetchedTimestampMsecs number
    (Integer) Specifies the last timestamp in UNIX time (milliseconds) when the connector upgrade status was fetched.
    message string
    (String) Specifies error message for upgrade failure.
    startTimestampMSecs number
    (Integer) Specifies the last timestamp in UNIX time (milliseconds) when the connector upgrade was triggered.
    status string
    (String) Specifies the last fetched upgrade status of the connector.

    • Constraints: Allowable values are: NotStarted, InProgress, Succeeded, Failed.
    last_status_fetched_timestamp_msecs float
    (Integer) Specifies the last timestamp in UNIX time (milliseconds) when the connector upgrade status was fetched.
    message str
    (String) Specifies error message for upgrade failure.
    start_timestamp_m_secs float
    (Integer) Specifies the last timestamp in UNIX time (milliseconds) when the connector upgrade was triggered.
    status str
    (String) Specifies the last fetched upgrade status of the connector.

    • Constraints: Allowable values are: NotStarted, InProgress, Succeeded, Failed.
    lastStatusFetchedTimestampMsecs Number
    (Integer) Specifies the last timestamp in UNIX time (milliseconds) when the connector upgrade status was fetched.
    message String
    (String) Specifies error message for upgrade failure.
    startTimestampMSecs Number
    (Integer) Specifies the last timestamp in UNIX time (milliseconds) when the connector upgrade was triggered.
    status String
    (String) Specifies the last fetched upgrade status of the connector.

    • Constraints: Allowable values are: NotStarted, InProgress, Succeeded, Failed.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud