Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nutanix
  3. API Docs
  4. getPcBackupTargetV2
Nutanix v0.8.0 published on Sunday, May 11, 2025 by Piers Karsenbarg
pierskarsenbarg/pulumi-nutanix

nutanix.getPcBackupTargetV2

Explore with Pulumi AI

nutanix logo
Nutanix v0.8.0 published on Sunday, May 11, 2025 by Piers Karsenbarg
pierskarsenbarg/pulumi-nutanix

    Retrieves the backup targets (cluster or object store) from a domain manager and returns the backup configuration and lastSyncTimestamp parameter to the user.

    Example Usage

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

const example = nutanix.getPcBackupTargetV2({
    domainManagerExtId: "75dde184-3a0e-4f59-a185-03ca1efead17",
    extId: "00062d3d-5d07-0da6-0000-000000028f57",
});

    import pulumi
import pulumi_nutanix as nutanix

example = nutanix.get_pc_backup_target_v2(domain_manager_ext_id="75dde184-3a0e-4f59-a185-03ca1efead17",
    ext_id="00062d3d-5d07-0da6-0000-000000028f57")

    package main

import (
	"github.com/pierskarsenbarg/pulumi-nutanix/sdk/go/nutanix"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := nutanix.LookupPcBackupTargetV2(ctx, &nutanix.LookupPcBackupTargetV2Args{
			DomainManagerExtId: "75dde184-3a0e-4f59-a185-03ca1efead17",
			ExtId:              "00062d3d-5d07-0da6-0000-000000028f57",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Nutanix.GetPcBackupTargetV2.Invoke(new()
    {
        DomainManagerExtId = "75dde184-3a0e-4f59-a185-03ca1efead17",
        ExtId = "00062d3d-5d07-0da6-0000-000000028f57",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nutanix.NutanixFunctions;
import com.pulumi.nutanix.inputs.GetPcBackupTargetV2Args;
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 example = NutanixFunctions.getPcBackupTargetV2(GetPcBackupTargetV2Args.builder()
            .domainManagerExtId("75dde184-3a0e-4f59-a185-03ca1efead17")
            .extId("00062d3d-5d07-0da6-0000-000000028f57")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: nutanix:getPcBackupTargetV2
      arguments:
        domainManagerExtId: 75dde184-3a0e-4f59-a185-03ca1efead17
        extId: 00062d3d-5d07-0da6-0000-000000028f57

    Using getPcBackupTargetV2

    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 getPcBackupTargetV2(args: GetPcBackupTargetV2Args, opts?: InvokeOptions): Promise<GetPcBackupTargetV2Result>
function getPcBackupTargetV2Output(args: GetPcBackupTargetV2OutputArgs, opts?: InvokeOptions): Output<GetPcBackupTargetV2Result>
    def get_pc_backup_target_v2(domain_manager_ext_id: Optional[str] = None,
                            ext_id: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetPcBackupTargetV2Result
def get_pc_backup_target_v2_output(domain_manager_ext_id: Optional[pulumi.Input[str]] = None,
                            ext_id: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetPcBackupTargetV2Result]
    func LookupPcBackupTargetV2(ctx *Context, args *LookupPcBackupTargetV2Args, opts ...InvokeOption) (*LookupPcBackupTargetV2Result, error)
func LookupPcBackupTargetV2Output(ctx *Context, args *LookupPcBackupTargetV2OutputArgs, opts ...InvokeOption) LookupPcBackupTargetV2ResultOutput

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

    public static class GetPcBackupTargetV2 
{
    public static Task<GetPcBackupTargetV2Result> InvokeAsync(GetPcBackupTargetV2Args args, InvokeOptions? opts = null)
    public static Output<GetPcBackupTargetV2Result> Invoke(GetPcBackupTargetV2InvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPcBackupTargetV2Result> getPcBackupTargetV2(GetPcBackupTargetV2Args args, InvokeOptions options)
public static Output<GetPcBackupTargetV2Result> getPcBackupTargetV2(GetPcBackupTargetV2Args args, InvokeOptions options)

    fn::invoke:
  function: nutanix:index/getPcBackupTargetV2:getPcBackupTargetV2
  arguments:
    # arguments dictionary

    The following arguments are supported:

    DomainManagerExtId string
    -(Required) A unique identifier for the domain manager.
    ExtId string
    -(Required) A globally unique identifier of an instance that is suitable for external consumption.
    DomainManagerExtId string
    -(Required) A unique identifier for the domain manager.
    ExtId string
    -(Required) A globally unique identifier of an instance that is suitable for external consumption.
    domainManagerExtId String
    -(Required) A unique identifier for the domain manager.
    extId String
    -(Required) A globally unique identifier of an instance that is suitable for external consumption.
    domainManagerExtId string
    -(Required) A unique identifier for the domain manager.
    extId string
    -(Required) A globally unique identifier of an instance that is suitable for external consumption.
    domain_manager_ext_id str
    -(Required) A unique identifier for the domain manager.
    ext_id str
    -(Required) A globally unique identifier of an instance that is suitable for external consumption.
    domainManagerExtId String
    -(Required) A unique identifier for the domain manager.
    extId String
    -(Required) A globally unique identifier of an instance that is suitable for external consumption.

    getPcBackupTargetV2 Result

    The following output properties are available:

    BackupPauseReason string
    • Specifies a reason why the backup might have paused. This will be empty if the isBackupPaused field is false.
    DomainManagerExtId string
    ExtId string
    • Cluster UUID of a remote cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsBackupPaused bool
    • Whether the backup is paused on the given cluster or not.
    LastSyncTime string
    • Represents the time when the domain manager was last synchronized or copied its configuration data to the backup target. This field is updated every 30 minutes.
    Links List<PiersKarsenbarg.Nutanix.Outputs.GetPcBackupTargetV2Link>
    • A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
    Locations List<PiersKarsenbarg.Nutanix.Outputs.GetPcBackupTargetV2Location>
    • Location of the backup target. For example, a cluster or an object store endpoint, such as AWS s3.
    TenantId string
    • A globally unique identifier that represents the tenant that owns this entity. The system automatically assigns it, and it and is immutable from an API consumer perspective (some use cases may cause this Id to change - For instance, a use case may require the transfer of ownership of the entity, but these cases are handled automatically on the server).
    BackupPauseReason string
    • Specifies a reason why the backup might have paused. This will be empty if the isBackupPaused field is false.
    DomainManagerExtId string
    ExtId string
    • Cluster UUID of a remote cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsBackupPaused bool
    • Whether the backup is paused on the given cluster or not.
    LastSyncTime string
    • Represents the time when the domain manager was last synchronized or copied its configuration data to the backup target. This field is updated every 30 minutes.
    Links []GetPcBackupTargetV2Link
    • A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
    Locations []GetPcBackupTargetV2Location
    • Location of the backup target. For example, a cluster or an object store endpoint, such as AWS s3.
    TenantId string
    • A globally unique identifier that represents the tenant that owns this entity. The system automatically assigns it, and it and is immutable from an API consumer perspective (some use cases may cause this Id to change - For instance, a use case may require the transfer of ownership of the entity, but these cases are handled automatically on the server).
    backupPauseReason String
    • Specifies a reason why the backup might have paused. This will be empty if the isBackupPaused field is false.
    domainManagerExtId String
    extId String
    • Cluster UUID of a remote cluster.
    id String
    The provider-assigned unique ID for this managed resource.
    isBackupPaused Boolean
    • Whether the backup is paused on the given cluster or not.
    lastSyncTime String
    • Represents the time when the domain manager was last synchronized or copied its configuration data to the backup target. This field is updated every 30 minutes.
    links List<GetPcBackupTargetV2Link>
    • A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
    locations List<GetPcBackupTargetV2Location>
    • Location of the backup target. For example, a cluster or an object store endpoint, such as AWS s3.
    tenantId String
    • A globally unique identifier that represents the tenant that owns this entity. The system automatically assigns it, and it and is immutable from an API consumer perspective (some use cases may cause this Id to change - For instance, a use case may require the transfer of ownership of the entity, but these cases are handled automatically on the server).
    backupPauseReason string
    • Specifies a reason why the backup might have paused. This will be empty if the isBackupPaused field is false.
    domainManagerExtId string
    extId string
    • Cluster UUID of a remote cluster.
    id string
    The provider-assigned unique ID for this managed resource.
    isBackupPaused boolean
    • Whether the backup is paused on the given cluster or not.
    lastSyncTime string
    • Represents the time when the domain manager was last synchronized or copied its configuration data to the backup target. This field is updated every 30 minutes.
    links GetPcBackupTargetV2Link[]
    • A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
    locations GetPcBackupTargetV2Location[]
    • Location of the backup target. For example, a cluster or an object store endpoint, such as AWS s3.
    tenantId string
    • A globally unique identifier that represents the tenant that owns this entity. The system automatically assigns it, and it and is immutable from an API consumer perspective (some use cases may cause this Id to change - For instance, a use case may require the transfer of ownership of the entity, but these cases are handled automatically on the server).
    backup_pause_reason str
    • Specifies a reason why the backup might have paused. This will be empty if the isBackupPaused field is false.
    domain_manager_ext_id str
    ext_id str
    • Cluster UUID of a remote cluster.
    id str
    The provider-assigned unique ID for this managed resource.
    is_backup_paused bool
    • Whether the backup is paused on the given cluster or not.
    last_sync_time str
    • Represents the time when the domain manager was last synchronized or copied its configuration data to the backup target. This field is updated every 30 minutes.
    links Sequence[GetPcBackupTargetV2Link]
    • A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
    locations Sequence[GetPcBackupTargetV2Location]
    • Location of the backup target. For example, a cluster or an object store endpoint, such as AWS s3.
    tenant_id str
    • A globally unique identifier that represents the tenant that owns this entity. The system automatically assigns it, and it and is immutable from an API consumer perspective (some use cases may cause this Id to change - For instance, a use case may require the transfer of ownership of the entity, but these cases are handled automatically on the server).
    backupPauseReason String
    • Specifies a reason why the backup might have paused. This will be empty if the isBackupPaused field is false.
    domainManagerExtId String
    extId String
    • Cluster UUID of a remote cluster.
    id String
    The provider-assigned unique ID for this managed resource.
    isBackupPaused Boolean
    • Whether the backup is paused on the given cluster or not.
    lastSyncTime String
    • Represents the time when the domain manager was last synchronized or copied its configuration data to the backup target. This field is updated every 30 minutes.
    links List<Property Map>
    • A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
    locations List<Property Map>
    • Location of the backup target. For example, a cluster or an object store endpoint, such as AWS s3.
    tenantId String
    • A globally unique identifier that represents the tenant that owns this entity. The system automatically assigns it, and it and is immutable from an API consumer perspective (some use cases may cause this Id to change - For instance, a use case may require the transfer of ownership of the entity, but these cases are handled automatically on the server).

    Supporting Types

    Href string
    Rel string
    Href string
    Rel string
    href String
    rel String
    href string
    rel string
    href str
    rel str
    href String
    rel String

    GetPcBackupTargetV2Location

    ClusterLocations List<PiersKarsenbarg.Nutanix.Inputs.GetPcBackupTargetV2LocationClusterLocation>
    • A boolean value indicating whether to enable lockdown mode for a cluster.
    ObjectStoreLocations List<PiersKarsenbarg.Nutanix.Inputs.GetPcBackupTargetV2LocationObjectStoreLocation>
    • Currently representing the build information to be used for the cluster creation.
    ClusterLocations []GetPcBackupTargetV2LocationClusterLocation
    • A boolean value indicating whether to enable lockdown mode for a cluster.
    ObjectStoreLocations []GetPcBackupTargetV2LocationObjectStoreLocation
    • Currently representing the build information to be used for the cluster creation.
    clusterLocations List<GetPcBackupTargetV2LocationClusterLocation>
    • A boolean value indicating whether to enable lockdown mode for a cluster.
    objectStoreLocations List<GetPcBackupTargetV2LocationObjectStoreLocation>
    • Currently representing the build information to be used for the cluster creation.
    clusterLocations GetPcBackupTargetV2LocationClusterLocation[]
    • A boolean value indicating whether to enable lockdown mode for a cluster.
    objectStoreLocations GetPcBackupTargetV2LocationObjectStoreLocation[]
    • Currently representing the build information to be used for the cluster creation.
    cluster_locations Sequence[GetPcBackupTargetV2LocationClusterLocation]
    • A boolean value indicating whether to enable lockdown mode for a cluster.
    object_store_locations Sequence[GetPcBackupTargetV2LocationObjectStoreLocation]
    • Currently representing the build information to be used for the cluster creation.
    clusterLocations List<Property Map>
    • A boolean value indicating whether to enable lockdown mode for a cluster.
    objectStoreLocations List<Property Map>
    • Currently representing the build information to be used for the cluster creation.

    GetPcBackupTargetV2LocationClusterLocation

    Configs []GetPcBackupTargetV2LocationClusterLocationConfig
    • Cluster reference of the remote cluster to be connected.
    configs List<GetPcBackupTargetV2LocationClusterLocationConfig>
    • Cluster reference of the remote cluster to be connected.
    configs GetPcBackupTargetV2LocationClusterLocationConfig[]
    • Cluster reference of the remote cluster to be connected.
    configs Sequence[GetPcBackupTargetV2LocationClusterLocationConfig]
    • Cluster reference of the remote cluster to be connected.
    configs List<Property Map>
    • Cluster reference of the remote cluster to be connected.

    GetPcBackupTargetV2LocationClusterLocationConfig

    ExtId string
    -(Required) A globally unique identifier of an instance that is suitable for external consumption.
    Name string
    • Name of the cluster.
    ExtId string
    -(Required) A globally unique identifier of an instance that is suitable for external consumption.
    Name string
    • Name of the cluster.
    extId String
    -(Required) A globally unique identifier of an instance that is suitable for external consumption.
    name String
    • Name of the cluster.
    extId string
    -(Required) A globally unique identifier of an instance that is suitable for external consumption.
    name string
    • Name of the cluster.
    ext_id str
    -(Required) A globally unique identifier of an instance that is suitable for external consumption.
    name str
    • Name of the cluster.
    extId String
    -(Required) A globally unique identifier of an instance that is suitable for external consumption.
    name String
    • Name of the cluster.

    GetPcBackupTargetV2LocationObjectStoreLocation

    BackupPolicies []GetPcBackupTargetV2LocationObjectStoreLocationBackupPolicy
    -(Optional) Backup policy for the object store provided.
    ProviderConfigs []GetPcBackupTargetV2LocationObjectStoreLocationProviderConfig
    -(Required) The base model of S3 object store endpoint where domain manager is backed up.
    backupPolicies List<GetPcBackupTargetV2LocationObjectStoreLocationBackupPolicy>
    -(Optional) Backup policy for the object store provided.
    providerConfigs List<GetPcBackupTargetV2LocationObjectStoreLocationProviderConfig>
    -(Required) The base model of S3 object store endpoint where domain manager is backed up.
    backupPolicies GetPcBackupTargetV2LocationObjectStoreLocationBackupPolicy[]
    -(Optional) Backup policy for the object store provided.
    providerConfigs GetPcBackupTargetV2LocationObjectStoreLocationProviderConfig[]
    -(Required) The base model of S3 object store endpoint where domain manager is backed up.
    backup_policies Sequence[GetPcBackupTargetV2LocationObjectStoreLocationBackupPolicy]
    -(Optional) Backup policy for the object store provided.
    provider_configs Sequence[GetPcBackupTargetV2LocationObjectStoreLocationProviderConfig]
    -(Required) The base model of S3 object store endpoint where domain manager is backed up.
    backupPolicies List<Property Map>
    -(Optional) Backup policy for the object store provided.
    providerConfigs List<Property Map>
    -(Required) The base model of S3 object store endpoint where domain manager is backed up.

    GetPcBackupTargetV2LocationObjectStoreLocationBackupPolicy

    RpoInMinutes int
    • RPO interval in minutes at which the backup will be taken. The Value should be in the range of 60 to 1440.
    RpoInMinutes int
    • RPO interval in minutes at which the backup will be taken. The Value should be in the range of 60 to 1440.
    rpoInMinutes Integer
    • RPO interval in minutes at which the backup will be taken. The Value should be in the range of 60 to 1440.
    rpoInMinutes number
    • RPO interval in minutes at which the backup will be taken. The Value should be in the range of 60 to 1440.
    rpo_in_minutes int
    • RPO interval in minutes at which the backup will be taken. The Value should be in the range of 60 to 1440.
    rpoInMinutes Number
    • RPO interval in minutes at which the backup will be taken. The Value should be in the range of 60 to 1440.

    GetPcBackupTargetV2LocationObjectStoreLocationProviderConfig

    BucketName string
    • The bucket name of the object store endpoint where backup data of domain manager is to be stored.
    Credentials List<PiersKarsenbarg.Nutanix.Inputs.GetPcBackupTargetV2LocationObjectStoreLocationProviderConfigCredential>
    • Secret credentials model for the object store containing access key ID and secret access key.
    Region string
    • The region name of the object store endpoint where backup data of domain manager is stored. Default is us-east-1.
    BucketName string
    • The bucket name of the object store endpoint where backup data of domain manager is to be stored.
    Credentials []GetPcBackupTargetV2LocationObjectStoreLocationProviderConfigCredential
    • Secret credentials model for the object store containing access key ID and secret access key.
    Region string
    • The region name of the object store endpoint where backup data of domain manager is stored. Default is us-east-1.
    bucketName String
    • The bucket name of the object store endpoint where backup data of domain manager is to be stored.
    credentials List<GetPcBackupTargetV2LocationObjectStoreLocationProviderConfigCredential>
    • Secret credentials model for the object store containing access key ID and secret access key.
    region String
    • The region name of the object store endpoint where backup data of domain manager is stored. Default is us-east-1.
    bucketName string
    • The bucket name of the object store endpoint where backup data of domain manager is to be stored.
    credentials GetPcBackupTargetV2LocationObjectStoreLocationProviderConfigCredential[]
    • Secret credentials model for the object store containing access key ID and secret access key.
    region string
    • The region name of the object store endpoint where backup data of domain manager is stored. Default is us-east-1.
    bucket_name str
    • The bucket name of the object store endpoint where backup data of domain manager is to be stored.
    credentials Sequence[GetPcBackupTargetV2LocationObjectStoreLocationProviderConfigCredential]
    • Secret credentials model for the object store containing access key ID and secret access key.
    region str
    • The region name of the object store endpoint where backup data of domain manager is stored. Default is us-east-1.
    bucketName String
    • The bucket name of the object store endpoint where backup data of domain manager is to be stored.
    credentials List<Property Map>
    • Secret credentials model for the object store containing access key ID and secret access key.
    region String
    • The region name of the object store endpoint where backup data of domain manager is stored. Default is us-east-1.

    GetPcBackupTargetV2LocationObjectStoreLocationProviderConfigCredential

    AccessKeyId string
    • Access key ID for the object store provided for backup target.
    SecretAccessKey string
    • Secret access key for the object store provided for backup target.
    AccessKeyId string
    • Access key ID for the object store provided for backup target.
    SecretAccessKey string
    • Secret access key for the object store provided for backup target.
    accessKeyId String
    • Access key ID for the object store provided for backup target.
    secretAccessKey String
    • Secret access key for the object store provided for backup target.
    accessKeyId string
    • Access key ID for the object store provided for backup target.
    secretAccessKey string
    • Secret access key for the object store provided for backup target.
    access_key_id str
    • Access key ID for the object store provided for backup target.
    secret_access_key str
    • Secret access key for the object store provided for backup target.
    accessKeyId String
    • Access key ID for the object store provided for backup target.
    secretAccessKey String
    • Secret access key for the object store provided for backup target.

    Package Details

    Repository
    nutanix pierskarsenbarg/pulumi-nutanix
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the nutanix Terraform Provider.
    nutanix logo
    Nutanix v0.8.0 published on Sunday, May 11, 2025 by Piers Karsenbarg
    pierskarsenbarg/pulumi-nutanix