nutanix.getPcBackupTargetsV2

Lists backup targets (cluster or object store) configured for a given domain manager.

Example Usage

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

const example = nutanix.getPcBackupTargetsV2({
    domainManagerExtId: "75dde184-3a0e-4f59-a185-03ca1efead17",
});

import pulumi
import pulumi_nutanix as nutanix

example = nutanix.get_pc_backup_targets_v2(domain_manager_ext_id="75dde184-3a0e-4f59-a185-03ca1efead17")

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.GetPcBackupTargetsV2(ctx, &nutanix.GetPcBackupTargetsV2Args{
			DomainManagerExtId: "75dde184-3a0e-4f59-a185-03ca1efead17",
		}, 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.GetPcBackupTargetsV2.Invoke(new()
    {
        DomainManagerExtId = "75dde184-3a0e-4f59-a185-03ca1efead17",
    });

});

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.GetPcBackupTargetsV2Args;
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.getPcBackupTargetsV2(GetPcBackupTargetsV2Args.builder()
            .domainManagerExtId("75dde184-3a0e-4f59-a185-03ca1efead17")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: nutanix:getPcBackupTargetsV2
      arguments:
        domainManagerExtId: 75dde184-3a0e-4f59-a185-03ca1efead17

Backup Targets

The backup_targets argument supports the following:

• tenant_id: - 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).
• ext_id: - A globally unique identifier of an instance that is suitable for external consumption.
• links: - 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.
• location: - Location of the backup target. For example, a cluster or an object store endpoint, such as AWS s3.
• last_sync_time: - 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.
• is_backup_paused: - Whether the backup is paused on the given cluster or not.
• backup_pause_reason: - Specifies a reason why the backup might have paused. This will be empty if the isBackupPaused field is false.

Location

The location argument exports the following:

• cluster_location: - A boolean value indicating whether to enable lockdown mode for a cluster.
• object_store_location: - Currently representing the build information to be used for the cluster creation.

Cluster Location

The cluster_location argument exports the following:

• config: - Cluster reference of the remote cluster to be connected.

Config

The config argument exports the following:

• ext_id: - Cluster UUID of a remote cluster.
• name: - Name of the cluster.

Object Store Location

The object_store_location argument exports the following:

• provider_config: -(Required) The base model of S3 object store endpoint where domain manager is backed up.
• backup_policy: -(Optional) Backup policy for the object store provided.

Provider Config

The provider_config argument exports the following:

• bucket_name: - The bucket name of the object store endpoint where backup data of domain manager is to be stored.
• region: - The region name of the object store endpoint where backup data of domain manager is stored. Default is us-east-1.
• credentials: - Secret credentials model for the object store containing access key ID and secret access key.

Credentials

The credentials argument exports the following:

• access_key_id: - Access key ID for the object store provided for backup target.
• secret_access_key: - Secret access key for the object store provided for backup target.

Backup Policy

The backup_policy argument exports the following:

• rpo_in_minutes: - RPO interval in minutes at which the backup will be taken. The Value should be in the range of 60 to 1440.

See detailed information in Nutanix List Backup Targets .

Using getPcBackupTargetsV2

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 getPcBackupTargetsV2(args: GetPcBackupTargetsV2Args, opts?: InvokeOptions): Promise<GetPcBackupTargetsV2Result>
function getPcBackupTargetsV2Output(args: GetPcBackupTargetsV2OutputArgs, opts?: InvokeOptions): Output<GetPcBackupTargetsV2Result>

def get_pc_backup_targets_v2(domain_manager_ext_id: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetPcBackupTargetsV2Result
def get_pc_backup_targets_v2_output(domain_manager_ext_id: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetPcBackupTargetsV2Result]

func GetPcBackupTargetsV2(ctx *Context, args *GetPcBackupTargetsV2Args, opts ...InvokeOption) (*GetPcBackupTargetsV2Result, error)
func GetPcBackupTargetsV2Output(ctx *Context, args *GetPcBackupTargetsV2OutputArgs, opts ...InvokeOption) GetPcBackupTargetsV2ResultOutput

public static class GetPcBackupTargetsV2 
{
    public static Task<GetPcBackupTargetsV2Result> InvokeAsync(GetPcBackupTargetsV2Args args, InvokeOptions? opts = null)
    public static Output<GetPcBackupTargetsV2Result> Invoke(GetPcBackupTargetsV2InvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPcBackupTargetsV2Result> getPcBackupTargetsV2(GetPcBackupTargetsV2Args args, InvokeOptions options)
public static Output<GetPcBackupTargetsV2Result> getPcBackupTargetsV2(GetPcBackupTargetsV2Args args, InvokeOptions options)

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

The following arguments are supported:

getPcBackupTargetsV2 Result

The following output properties are available:

Supporting Types

GetPcBackupTargetsV2BackupTarget

GetPcBackupTargetsV2BackupTargetLink

GetPcBackupTargetsV2BackupTargetLocation

GetPcBackupTargetsV2BackupTargetLocationClusterLocation

GetPcBackupTargetsV2BackupTargetLocationClusterLocationConfig

GetPcBackupTargetsV2BackupTargetLocationObjectStoreLocation

GetPcBackupTargetsV2BackupTargetLocationObjectStoreLocationBackupPolicy

GetPcBackupTargetsV2BackupTargetLocationObjectStoreLocationProviderConfig

GetPcBackupTargetsV2BackupTargetLocationObjectStoreLocationProviderConfigCredential

Package Details

Repository

nutanix pierskarsenbarg/pulumi-nutanix

License

Apache-2.0

Notes

This Pulumi package is based on the nutanix Terraform Provider.