1. Packages
  2. Nutanix
  3. API Docs
  4. getPcRestoreSourceV2
Nutanix v0.8.0 published on Sunday, May 11, 2025 by Piers Karsenbarg

nutanix.getPcRestoreSourceV2

Explore with Pulumi AI

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

    Retrieves the restore source from the PE cache store and returns the restore source configuration and external identifier to the user.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as nutanix from "@pierskarsenbarg/nutanix";
    import * as nutanix from "@pulumi/nutanix";
    
    //defining nutanix configuration for PE
    const pe = new nutanix.Provider("pe", {
        username: _var.nutanix_pe_username,
        password: _var.nutanix_pe_password,
        endpoint: _var.nutanix_pe_endpoint,
        insecure: true,
        port: "9440",
    });
    const restore_source = nutanix.getPcRestoreSourceV2({
        extId: "323860ca-bd10-411e-9fe0-1430b62eaf45",
    });
    
    import pulumi
    import pulumi_nutanix as nutanix
    
    #defining nutanix configuration for PE
    pe = nutanix.Provider("pe",
        username=var["nutanix_pe_username"],
        password=var["nutanix_pe_password"],
        endpoint=var["nutanix_pe_endpoint"],
        insecure=True,
        port="9440")
    restore_source = nutanix.get_pc_restore_source_v2(ext_id="323860ca-bd10-411e-9fe0-1430b62eaf45")
    
    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 {
    		// defining nutanix configuration for PE
    		_, err := nutanix.NewProvider(ctx, "pe", &nutanix.ProviderArgs{
    			Username: pulumi.Any(_var.Nutanix_pe_username),
    			Password: pulumi.Any(_var.Nutanix_pe_password),
    			Endpoint: pulumi.Any(_var.Nutanix_pe_endpoint),
    			Insecure: pulumi.Bool(true),
    			Port:     pulumi.String("9440"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = nutanix.LookupPcRestoreSourceV2(ctx, &nutanix.LookupPcRestoreSourceV2Args{
    			ExtId: "323860ca-bd10-411e-9fe0-1430b62eaf45",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Nutanix = PiersKarsenbarg.Nutanix;
    using Nutanix = Pulumi.Nutanix;
    
    return await Deployment.RunAsync(() => 
    {
        //defining nutanix configuration for PE
        var pe = new Nutanix.Provider("pe", new()
        {
            Username = @var.Nutanix_pe_username,
            Password = @var.Nutanix_pe_password,
            Endpoint = @var.Nutanix_pe_endpoint,
            Insecure = true,
            Port = "9440",
        });
    
        var restore_source = Nutanix.GetPcRestoreSourceV2.Invoke(new()
        {
            ExtId = "323860ca-bd10-411e-9fe0-1430b62eaf45",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.nutanix.Provider;
    import com.pulumi.nutanix.ProviderArgs;
    import com.pulumi.nutanix.NutanixFunctions;
    import com.pulumi.nutanix.inputs.GetPcRestoreSourceV2Args;
    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) {
            //defining nutanix configuration for PE
            var pe = new Provider("pe", ProviderArgs.builder()
                .username(var_.nutanix_pe_username())
                .password(var_.nutanix_pe_password())
                .endpoint(var_.nutanix_pe_endpoint())
                .insecure(true)
                .port("9440")
                .build());
    
            final var restore-source = NutanixFunctions.getPcRestoreSourceV2(GetPcRestoreSourceV2Args.builder()
                .extId("323860ca-bd10-411e-9fe0-1430b62eaf45")
                .build());
    
        }
    }
    
    resources:
      #defining nutanix configuration for PE
      pe:
        type: pulumi:providers:nutanix
        properties:
          username: ${var.nutanix_pe_username}
          password: ${var.nutanix_pe_password}
          endpoint: ${var.nutanix_pe_endpoint}
          # PE endpoint
          insecure: true
          port: 9440
    variables:
      restore-source:
        fn::invoke:
          function: nutanix:getPcRestoreSourceV2
          arguments:
            extId: 323860ca-bd10-411e-9fe0-1430b62eaf45
    

    Using getPcRestoreSourceV2

    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 getPcRestoreSourceV2(args: GetPcRestoreSourceV2Args, opts?: InvokeOptions): Promise<GetPcRestoreSourceV2Result>
    function getPcRestoreSourceV2Output(args: GetPcRestoreSourceV2OutputArgs, opts?: InvokeOptions): Output<GetPcRestoreSourceV2Result>
    def get_pc_restore_source_v2(ext_id: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetPcRestoreSourceV2Result
    def get_pc_restore_source_v2_output(ext_id: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetPcRestoreSourceV2Result]
    func LookupPcRestoreSourceV2(ctx *Context, args *LookupPcRestoreSourceV2Args, opts ...InvokeOption) (*LookupPcRestoreSourceV2Result, error)
    func LookupPcRestoreSourceV2Output(ctx *Context, args *LookupPcRestoreSourceV2OutputArgs, opts ...InvokeOption) LookupPcRestoreSourceV2ResultOutput

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

    public static class GetPcRestoreSourceV2 
    {
        public static Task<GetPcRestoreSourceV2Result> InvokeAsync(GetPcRestoreSourceV2Args args, InvokeOptions? opts = null)
        public static Output<GetPcRestoreSourceV2Result> Invoke(GetPcRestoreSourceV2InvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPcRestoreSourceV2Result> getPcRestoreSourceV2(GetPcRestoreSourceV2Args args, InvokeOptions options)
    public static Output<GetPcRestoreSourceV2Result> getPcRestoreSourceV2(GetPcRestoreSourceV2Args args, InvokeOptions options)
    
    fn::invoke:
      function: nutanix:index/getPcRestoreSourceV2:getPcRestoreSourceV2
      arguments:
        # arguments dictionary

    The following arguments are supported:

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

    getPcRestoreSourceV2 Result

    The following output properties are available:

    ExtId string
    • Cluster UUID of a remote cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    Links List<PiersKarsenbarg.Nutanix.Outputs.GetPcRestoreSourceV2Link>
    • 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.GetPcRestoreSourceV2Location>
    • 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).
    ExtId string
    • Cluster UUID of a remote cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    Links []GetPcRestoreSourceV2Link
    • 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 []GetPcRestoreSourceV2Location
    • 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).
    extId String
    • Cluster UUID of a remote cluster.
    id String
    The provider-assigned unique ID for this managed resource.
    links List<GetPcRestoreSourceV2Link>
    • 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<GetPcRestoreSourceV2Location>
    • 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).
    extId string
    • Cluster UUID of a remote cluster.
    id string
    The provider-assigned unique ID for this managed resource.
    links GetPcRestoreSourceV2Link[]
    • 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 GetPcRestoreSourceV2Location[]
    • 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).
    ext_id str
    • Cluster UUID of a remote cluster.
    id str
    The provider-assigned unique ID for this managed resource.
    links Sequence[GetPcRestoreSourceV2Link]
    • 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[GetPcRestoreSourceV2Location]
    • 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).
    extId String
    • Cluster UUID of a remote cluster.
    id String
    The provider-assigned unique ID for this managed resource.
    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

    GetPcRestoreSourceV2Location

    ClusterLocations List<PiersKarsenbarg.Nutanix.Inputs.GetPcRestoreSourceV2LocationClusterLocation>
    • A boolean value indicating whether to enable lockdown mode for a cluster.
    ObjectStoreLocations List<PiersKarsenbarg.Nutanix.Inputs.GetPcRestoreSourceV2LocationObjectStoreLocation>
    • Currently representing the build information to be used for the cluster creation.
    ClusterLocations []GetPcRestoreSourceV2LocationClusterLocation
    • A boolean value indicating whether to enable lockdown mode for a cluster.
    ObjectStoreLocations []GetPcRestoreSourceV2LocationObjectStoreLocation
    • Currently representing the build information to be used for the cluster creation.
    clusterLocations List<GetPcRestoreSourceV2LocationClusterLocation>
    • A boolean value indicating whether to enable lockdown mode for a cluster.
    objectStoreLocations List<GetPcRestoreSourceV2LocationObjectStoreLocation>
    • Currently representing the build information to be used for the cluster creation.
    clusterLocations GetPcRestoreSourceV2LocationClusterLocation[]
    • A boolean value indicating whether to enable lockdown mode for a cluster.
    objectStoreLocations GetPcRestoreSourceV2LocationObjectStoreLocation[]
    • Currently representing the build information to be used for the cluster creation.
    cluster_locations Sequence[GetPcRestoreSourceV2LocationClusterLocation]
    • A boolean value indicating whether to enable lockdown mode for a cluster.
    object_store_locations Sequence[GetPcRestoreSourceV2LocationObjectStoreLocation]
    • 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.

    GetPcRestoreSourceV2LocationClusterLocation

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

    GetPcRestoreSourceV2LocationClusterLocationConfig

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

    GetPcRestoreSourceV2LocationObjectStoreLocation

    BackupPolicies []GetPcRestoreSourceV2LocationObjectStoreLocationBackupPolicy
    • Backup policy for the object store provided.
    ProviderConfigs []GetPcRestoreSourceV2LocationObjectStoreLocationProviderConfig
    • The base model of S3 object store endpoint where domain manager is backed up.
    backupPolicies List<GetPcRestoreSourceV2LocationObjectStoreLocationBackupPolicy>
    • Backup policy for the object store provided.
    providerConfigs List<GetPcRestoreSourceV2LocationObjectStoreLocationProviderConfig>
    • The base model of S3 object store endpoint where domain manager is backed up.
    backupPolicies GetPcRestoreSourceV2LocationObjectStoreLocationBackupPolicy[]
    • Backup policy for the object store provided.
    providerConfigs GetPcRestoreSourceV2LocationObjectStoreLocationProviderConfig[]
    • The base model of S3 object store endpoint where domain manager is backed up.
    backup_policies Sequence[GetPcRestoreSourceV2LocationObjectStoreLocationBackupPolicy]
    • Backup policy for the object store provided.
    provider_configs Sequence[GetPcRestoreSourceV2LocationObjectStoreLocationProviderConfig]
    • The base model of S3 object store endpoint where domain manager is backed up.
    backupPolicies List<Property Map>
    • Backup policy for the object store provided.
    providerConfigs List<Property Map>
    • The base model of S3 object store endpoint where domain manager is backed up.

    GetPcRestoreSourceV2LocationObjectStoreLocationBackupPolicy

    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.

    GetPcRestoreSourceV2LocationObjectStoreLocationProviderConfig

    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.GetPcRestoreSourceV2LocationObjectStoreLocationProviderConfigCredential>
    • 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 []GetPcRestoreSourceV2LocationObjectStoreLocationProviderConfigCredential
    • 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<GetPcRestoreSourceV2LocationObjectStoreLocationProviderConfigCredential>
    • 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 GetPcRestoreSourceV2LocationObjectStoreLocationProviderConfigCredential[]
    • 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[GetPcRestoreSourceV2LocationObjectStoreLocationProviderConfigCredential]
    • 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.

    GetPcRestoreSourceV2LocationObjectStoreLocationProviderConfigCredential

    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