Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Ibm Provider
  4. API Docs
  5. getBackupRecoveryVaultFailoverStatus
Viewing docs for ibm 2.9.0
published on Thursday, Nov 5, 2026 by ibm-cloud
Schema (JSON)
ibm-cloud/terraform-provider-ibm

ibm.getBackupRecoveryVaultFailoverStatus

ibm
Viewing docs for ibm 2.9.0
published on Thursday, Nov 5, 2026 by ibm-cloud
Schema (JSON)
ibm-cloud/terraform-provider-ibm

    Provides a read-only data source to retrieve information about Get Batch Vault Failover Status. 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 backupRecoveryVaultFailoverStatus = ibm.getBackupRecoveryVaultFailoverStatus({
    cloudType: "ibm",
    vaultIds: [8],
    xIbmTenantId: "tenantId",
});

    import pulumi
import pulumi_ibm as ibm

backup_recovery_vault_failover_status = ibm.get_backup_recovery_vault_failover_status(cloud_type="ibm",
    vault_ids=[8],
    x_ibm_tenant_id="tenantId")

    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.GetBackupRecoveryVaultFailoverStatus(ctx, &ibm.GetBackupRecoveryVaultFailoverStatusArgs{
			CloudType: "ibm",
			VaultIds: []float64{
				8,
			},
			XIbmTenantId: "tenantId",
		}, 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 backupRecoveryVaultFailoverStatus = Ibm.GetBackupRecoveryVaultFailoverStatus.Invoke(new()
    {
        CloudType = "ibm",
        VaultIds = new[]
        {
            8,
        },
        XIbmTenantId = "tenantId",
    });

});

    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.GetBackupRecoveryVaultFailoverStatusArgs;
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 backupRecoveryVaultFailoverStatus = IbmFunctions.getBackupRecoveryVaultFailoverStatus(GetBackupRecoveryVaultFailoverStatusArgs.builder()
            .cloudType("ibm")
            .vaultIds(8)
            .xIbmTenantId("tenantId")
            .build());

    }
}

    variables:
  backupRecoveryVaultFailoverStatus:
    fn::invoke:
      function: ibm:getBackupRecoveryVaultFailoverStatus
      arguments:
        cloudType: ibm
        vaultIds:
          - 8
        xIbmTenantId: tenantId

    Example coming soon!

    Using getBackupRecoveryVaultFailoverStatus

    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 getBackupRecoveryVaultFailoverStatus(args: GetBackupRecoveryVaultFailoverStatusArgs, opts?: InvokeOptions): Promise<GetBackupRecoveryVaultFailoverStatusResult>
function getBackupRecoveryVaultFailoverStatusOutput(args: GetBackupRecoveryVaultFailoverStatusOutputArgs, opts?: InvokeOutputOptions): Output<GetBackupRecoveryVaultFailoverStatusResult>
    def get_backup_recovery_vault_failover_status(cloud_type: Optional[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,
                                              vault_ids: Optional[Sequence[float]] = None,
                                              x_ibm_tenant_id: Optional[str] = None,
                                              opts: Optional[InvokeOptions] = None) -> GetBackupRecoveryVaultFailoverStatusResult
def get_backup_recovery_vault_failover_status_output(cloud_type: pulumi.Input[Optional[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,
                                              vault_ids: pulumi.Input[Optional[Sequence[pulumi.Input[float]]]] = None,
                                              x_ibm_tenant_id: pulumi.Input[Optional[str]] = None,
                                              opts: Optional[InvokeOutputOptions] = None) -> Output[GetBackupRecoveryVaultFailoverStatusResult]
    func GetBackupRecoveryVaultFailoverStatus(ctx *Context, args *GetBackupRecoveryVaultFailoverStatusArgs, opts ...InvokeOption) (*GetBackupRecoveryVaultFailoverStatusResult, error)
func GetBackupRecoveryVaultFailoverStatusOutput(ctx *Context, args *GetBackupRecoveryVaultFailoverStatusOutputArgs, opts ...InvokeOption) GetBackupRecoveryVaultFailoverStatusResultOutput

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

    public static class GetBackupRecoveryVaultFailoverStatus 
{
    public static Task<GetBackupRecoveryVaultFailoverStatusResult> InvokeAsync(GetBackupRecoveryVaultFailoverStatusArgs args, InvokeOptions? opts = null)
    public static Output<GetBackupRecoveryVaultFailoverStatusResult> Invoke(GetBackupRecoveryVaultFailoverStatusInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetBackupRecoveryVaultFailoverStatusResult> Invoke(GetBackupRecoveryVaultFailoverStatusInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetBackupRecoveryVaultFailoverStatusResult> getBackupRecoveryVaultFailoverStatus(GetBackupRecoveryVaultFailoverStatusArgs args, InvokeOptions options)
public static Output<GetBackupRecoveryVaultFailoverStatusResult> getBackupRecoveryVaultFailoverStatus(GetBackupRecoveryVaultFailoverStatusArgs args, InvokeOptions options)
public static Output<GetBackupRecoveryVaultFailoverStatusResult> getBackupRecoveryVaultFailoverStatus(GetBackupRecoveryVaultFailoverStatusArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: ibm:index/getBackupRecoveryVaultFailoverStatus:getBackupRecoveryVaultFailoverStatus
  arguments:
    # arguments dictionary
    data "ibm_get_backup_recovery_vault_failover_status" "name" {
    # arguments
}

    The following arguments are supported:

    CloudType string
    Specifies the cloud environment type where the Backup and Recovery instance is used. Currently, only 'ibm' is supported for failovers.

    • Constraints: Allowable values are: ibm.
    VaultIds List<double>
    Specifies the unique ids of the Backup and Recovery instances i.e. vaults for which the latest failover status is to be fetched.
    XIbmTenantId string
    Id of the tenant accessing the cluster.
    EndpointType string
    Id string
    The unique identifier of the Get Batch Vault Failover Status.
    InstanceId string
    Region string
    ServiceName string
    CloudType string
    Specifies the cloud environment type where the Backup and Recovery instance is used. Currently, only 'ibm' is supported for failovers.

    • Constraints: Allowable values are: ibm.
    VaultIds []float64
    Specifies the unique ids of the Backup and Recovery instances i.e. vaults for which the latest failover status is to be fetched.
    XIbmTenantId string
    Id of the tenant accessing the cluster.
    EndpointType string
    Id string
    The unique identifier of the Get Batch Vault Failover Status.
    InstanceId string
    Region string
    ServiceName string
    cloud_type string
    Specifies the cloud environment type where the Backup and Recovery instance is used. Currently, only 'ibm' is supported for failovers.

    • Constraints: Allowable values are: ibm.
    vault_ids list(number)
    Specifies the unique ids of the Backup and Recovery instances i.e. vaults for which the latest failover status is to be fetched.
    x_ibm_tenant_id string
    Id of the tenant accessing the cluster.
    endpoint_type string
    id string
    The unique identifier of the Get Batch Vault Failover Status.
    instance_id string
    region string
    service_name string
    cloudType String
    Specifies the cloud environment type where the Backup and Recovery instance is used. Currently, only 'ibm' is supported for failovers.

    • Constraints: Allowable values are: ibm.
    vaultIds List<Double>
    Specifies the unique ids of the Backup and Recovery instances i.e. vaults for which the latest failover status is to be fetched.
    xIbmTenantId String
    Id of the tenant accessing the cluster.
    endpointType String
    id String
    The unique identifier of the Get Batch Vault Failover Status.
    instanceId String
    region String
    serviceName String
    cloudType string
    Specifies the cloud environment type where the Backup and Recovery instance is used. Currently, only 'ibm' is supported for failovers.

    • Constraints: Allowable values are: ibm.
    vaultIds number[]
    Specifies the unique ids of the Backup and Recovery instances i.e. vaults for which the latest failover status is to be fetched.
    xIbmTenantId string
    Id of the tenant accessing the cluster.
    endpointType string
    id string
    The unique identifier of the Get Batch Vault Failover Status.
    instanceId string
    region string
    serviceName string
    cloud_type str
    Specifies the cloud environment type where the Backup and Recovery instance is used. Currently, only 'ibm' is supported for failovers.

    • Constraints: Allowable values are: ibm.
    vault_ids Sequence[float]
    Specifies the unique ids of the Backup and Recovery instances i.e. vaults for which the latest failover status is to be fetched.
    x_ibm_tenant_id str
    Id of the tenant accessing the cluster.
    endpoint_type str
    id str
    The unique identifier of the Get Batch Vault Failover Status.
    instance_id str
    region str
    service_name str
    cloudType String
    Specifies the cloud environment type where the Backup and Recovery instance is used. Currently, only 'ibm' is supported for failovers.

    • Constraints: Allowable values are: ibm.
    vaultIds List<Number>
    Specifies the unique ids of the Backup and Recovery instances i.e. vaults for which the latest failover status is to be fetched.
    xIbmTenantId String
    Id of the tenant accessing the cluster.
    endpointType String
    id String
    The unique identifier of the Get Batch Vault Failover Status.
    instanceId String
    region String
    serviceName String

    getBackupRecoveryVaultFailoverStatus Result

    The following output properties are available:

    CloudType string
    ErrorMessage string
    (String) Specifies the error message if the vault failover failed.
    FailoverStatuses List<GetBackupRecoveryVaultFailoverStatusFailoverStatus>
    (List) Array of failover statuses for the specified Backup and Recovery instances. Nested schema for failover_statuses:
    Id string
    The unique identifier of the Get Batch Vault Failover Status.
    Region string
    VaultIds List<double>
    XIbmTenantId string
    EndpointType string
    InstanceId string
    ServiceName string
    CloudType string
    ErrorMessage string
    (String) Specifies the error message if the vault failover failed.
    FailoverStatuses []GetBackupRecoveryVaultFailoverStatusFailoverStatus
    (List) Array of failover statuses for the specified Backup and Recovery instances. Nested schema for failover_statuses:
    Id string
    The unique identifier of the Get Batch Vault Failover Status.
    Region string
    VaultIds []float64
    XIbmTenantId string
    EndpointType string
    InstanceId string
    ServiceName string
    cloud_type string
    error_message string
    (String) Specifies the error message if the vault failover failed.
    failover_statuses list(object)
    (List) Array of failover statuses for the specified Backup and Recovery instances. Nested schema for failover_statuses:
    id string
    The unique identifier of the Get Batch Vault Failover Status.
    region string
    vault_ids list(number)
    x_ibm_tenant_id string
    endpoint_type string
    instance_id string
    service_name string
    cloudType String
    errorMessage String
    (String) Specifies the error message if the vault failover failed.
    failoverStatuses List<GetBackupRecoveryVaultFailoverStatusFailoverStatus>
    (List) Array of failover statuses for the specified Backup and Recovery instances. Nested schema for failover_statuses:
    id String
    The unique identifier of the Get Batch Vault Failover Status.
    region String
    vaultIds List<Double>
    xIbmTenantId String
    endpointType String
    instanceId String
    serviceName String
    cloudType string
    errorMessage string
    (String) Specifies the error message if the vault failover failed.
    failoverStatuses GetBackupRecoveryVaultFailoverStatusFailoverStatus[]
    (List) Array of failover statuses for the specified Backup and Recovery instances. Nested schema for failover_statuses:
    id string
    The unique identifier of the Get Batch Vault Failover Status.
    region string
    vaultIds number[]
    xIbmTenantId string
    endpointType string
    instanceId string
    serviceName string
    cloud_type str
    error_message str
    (String) Specifies the error message if the vault failover failed.
    failover_statuses Sequence[GetBackupRecoveryVaultFailoverStatusFailoverStatus]
    (List) Array of failover statuses for the specified Backup and Recovery instances. Nested schema for failover_statuses:
    id str
    The unique identifier of the Get Batch Vault Failover Status.
    region str
    vault_ids Sequence[float]
    x_ibm_tenant_id str
    endpoint_type str
    instance_id str
    service_name str
    cloudType String
    errorMessage String
    (String) Specifies the error message if the vault failover failed.
    failoverStatuses List<Property Map>
    (List) Array of failover statuses for the specified Backup and Recovery instances. Nested schema for failover_statuses:
    id String
    The unique identifier of the Get Batch Vault Failover Status.
    region String
    vaultIds List<Number>
    xIbmTenantId String
    endpointType String
    instanceId String
    serviceName String

    Supporting Types

    GetBackupRecoveryVaultFailoverStatusFailoverStatus

    Statuses List<GetBackupRecoveryVaultFailoverStatusFailoverStatusStatus>
    (String) Specifies the current status of the failover.

    • Constraints: Allowable values are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, LegalHold.
    VaultId double
    (Integer) Specifies the unique id of the Backup and Recovery instance.
    Statuses []GetBackupRecoveryVaultFailoverStatusFailoverStatusStatus
    (String) Specifies the current status of the failover.

    • Constraints: Allowable values are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, LegalHold.
    VaultId float64
    (Integer) Specifies the unique id of the Backup and Recovery instance.
    statuses list(object)
    (String) Specifies the current status of the failover.

    • Constraints: Allowable values are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, LegalHold.
    vault_id number
    (Integer) Specifies the unique id of the Backup and Recovery instance.
    statuses List<GetBackupRecoveryVaultFailoverStatusFailoverStatusStatus>
    (String) Specifies the current status of the failover.

    • Constraints: Allowable values are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, LegalHold.
    vaultId Double
    (Integer) Specifies the unique id of the Backup and Recovery instance.
    statuses GetBackupRecoveryVaultFailoverStatusFailoverStatusStatus[]
    (String) Specifies the current status of the failover.

    • Constraints: Allowable values are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, LegalHold.
    vaultId number
    (Integer) Specifies the unique id of the Backup and Recovery instance.
    statuses Sequence[GetBackupRecoveryVaultFailoverStatusFailoverStatusStatus]
    (String) Specifies the current status of the failover.

    • Constraints: Allowable values are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, LegalHold.
    vault_id float
    (Integer) Specifies the unique id of the Backup and Recovery instance.
    statuses List<Property Map>
    (String) Specifies the current status of the failover.

    • Constraints: Allowable values are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, LegalHold.
    vaultId Number
    (Integer) Specifies the unique id of the Backup and Recovery instance.

    GetBackupRecoveryVaultFailoverStatusFailoverStatusStatus

    EndTimeUsecs double
    (Integer) Specifies the end time of the failover in microseconds since epoch.
    ErrorMessage string
    (String) Specifies the error message if the vault failover failed.
    StartTimeUsecs double
    (Integer) Specifies the start time of the failover in microseconds since epoch.
    Status string
    (String) Specifies the current status of the failover.

    • Constraints: Allowable values are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, LegalHold.
    Uid string
    (String) Specifies the unique id of the failover.
    EndTimeUsecs float64
    (Integer) Specifies the end time of the failover in microseconds since epoch.
    ErrorMessage string
    (String) Specifies the error message if the vault failover failed.
    StartTimeUsecs float64
    (Integer) Specifies the start time of the failover in microseconds since epoch.
    Status string
    (String) Specifies the current status of the failover.

    • Constraints: Allowable values are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, LegalHold.
    Uid string
    (String) Specifies the unique id of the failover.
    end_time_usecs number
    (Integer) Specifies the end time of the failover in microseconds since epoch.
    error_message string
    (String) Specifies the error message if the vault failover failed.
    start_time_usecs number
    (Integer) Specifies the start time of the failover in microseconds since epoch.
    status string
    (String) Specifies the current status of the failover.

    • Constraints: Allowable values are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, LegalHold.
    uid string
    (String) Specifies the unique id of the failover.
    endTimeUsecs Double
    (Integer) Specifies the end time of the failover in microseconds since epoch.
    errorMessage String
    (String) Specifies the error message if the vault failover failed.
    startTimeUsecs Double
    (Integer) Specifies the start time of the failover in microseconds since epoch.
    status String
    (String) Specifies the current status of the failover.

    • Constraints: Allowable values are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, LegalHold.
    uid String
    (String) Specifies the unique id of the failover.
    endTimeUsecs number
    (Integer) Specifies the end time of the failover in microseconds since epoch.
    errorMessage string
    (String) Specifies the error message if the vault failover failed.
    startTimeUsecs number
    (Integer) Specifies the start time of the failover in microseconds since epoch.
    status string
    (String) Specifies the current status of the failover.

    • Constraints: Allowable values are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, LegalHold.
    uid string
    (String) Specifies the unique id of the failover.
    end_time_usecs float
    (Integer) Specifies the end time of the failover in microseconds since epoch.
    error_message str
    (String) Specifies the error message if the vault failover failed.
    start_time_usecs float
    (Integer) Specifies the start time of the failover in microseconds since epoch.
    status str
    (String) Specifies the current status of the failover.

    • Constraints: Allowable values are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, LegalHold.
    uid str
    (String) Specifies the unique id of the failover.
    endTimeUsecs Number
    (Integer) Specifies the end time of the failover in microseconds since epoch.
    errorMessage String
    (String) Specifies the error message if the vault failover failed.
    startTimeUsecs Number
    (Integer) Specifies the start time of the failover in microseconds since epoch.
    status String
    (String) Specifies the current status of the failover.

    • Constraints: Allowable values are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, LegalHold.
    uid String
    (String) Specifies the unique id of the failover.

    Package Details

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

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial