Nutanix v0.8.0, May 11 25

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

nutanix.getRecoveryPointsV2

Explore with Pulumi AI

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

Example Usage

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

const recoveryPoints = nutanix.getRecoveryPointsV2({});
const filteredRecoveryPoints = nutanix.getRecoveryPointsV2({
    filter: "name eq 'recovery_point_001'",
});

import pulumi
import pulumi_nutanix as nutanix

recovery_points = nutanix.get_recovery_points_v2()
filtered_recovery_points = nutanix.get_recovery_points_v2(filter="name eq 'recovery_point_001'")

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.LookupRecoveryPointsV2(ctx, &nutanix.LookupRecoveryPointsV2Args{}, nil)
		if err != nil {
			return err
		}
		_, err = nutanix.LookupRecoveryPointsV2(ctx, &nutanix.LookupRecoveryPointsV2Args{
			Filter: pulumi.StringRef("name eq 'recovery_point_001'"),
		}, 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 recoveryPoints = Nutanix.GetRecoveryPointsV2.Invoke();

    var filteredRecoveryPoints = Nutanix.GetRecoveryPointsV2.Invoke(new()
    {
        Filter = "name eq 'recovery_point_001'",
    });

});

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.GetRecoveryPointsV2Args;
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 recoveryPoints = NutanixFunctions.getRecoveryPointsV2(GetRecoveryPointsV2Args.builder()
            .build());

        final var filteredRecoveryPoints = NutanixFunctions.getRecoveryPointsV2(GetRecoveryPointsV2Args.builder()
            .filter("name eq 'recovery_point_001'")
            .build());

    }
}

variables:
  recoveryPoints:
    fn::invoke:
      function: nutanix:getRecoveryPointsV2
      arguments: {}
  filteredRecoveryPoints:
    fn::invoke:
      function: nutanix:getRecoveryPointsV2
      arguments:
        filter: name eq 'recovery_point_001'

Recovery Points

The recovery_points attribute contains list of recovery points. Each recovery point contains the following attributes:

ext_id: recovery point UUID
tenant_id: A globally unique identifier that represents the tenant that owns this entity
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_agnostic_id: Location agnostic identifier of the Recovery point.
name: The name of the Recovery point.
creation_time: The UTC date and time in ISO-8601 format when the Recovery point is created.
expiration_time: The UTC date and time in ISO-8601 format when the current Recovery point expires and will be garbage collected.
status: The status of the Recovery point, which indicates whether this Recovery point is fit to be consumed.
- supported values:
  - COMPLETE: - The Recovery point is in a complete state and ready to be consumed.
recovery_point_type: Type of the Recovery point.
- supported values:
  - CRASH_CONSISTENT: - capture all the VM and application level details.
  - APPLICATION_CONSISTENT: - stored in the memory and also the in-progress transaction details.
owner_ext_id: A read only field inserted into recovery point at the time of recovery point creation, indicating the external identifier of the user who created this recovery point.
location_references: List of location references where the VM or volume group recovery point are a part of the specified recovery point.
vm_recovery_points: List of VM recovery point that are a part of the specified top-level recovery point. Note that a recovery point can contain a maximum number of 30 entities. These entities can be a combination of VM(s) and volume group(s).
volume_group_recovery_points: List of volume group recovery point that are a part of the specified top-level recovery point. Note that a recovery point can contain a maximum number of 30 entities. These entities can be a combination of VM(s) and volume group(s).

location_references

location_ext_id: External identifier of the cluster where the recovery point is present.

vm_recovery_points

ext_id: recovery point UUID
tenant_id: A globally unique identifier that represents the tenant that owns this entity
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.
consistency_group_ext_id: External identifier of the Consistency group which the VM was part of at the time of recovery point creation.
location_agnostic_id: Location agnostic identifier of the Recovery point.
name : The name of the Recovery point.
creation_time: The UTC date and time in ISO-8601 format when the Recovery point is created.
expiration_time: The UTC date and time in ISO-8601 format when the current Recovery point expires and will be garbage collected.
status: The status of the Recovery point, which indicates whether this Recovery point is fit to be consumed.
- supported values:
  - COMPLETE: - The Recovery point is in a complete state and ready to be consumed.
recovery_point_type: Type of the Recovery point.
disk_recovery_points: array of disk recovery points.
vm_ext_id: VM external identifier which is captured as a part of this recovery point.
vm_categories: Category key-value pairs associated with the VM at the time of recovery point creation. The category key and value are separated by ‘/’. For example, a category with key ‘dept’ and value ‘hr’ is displayed as ‘dept/hr’.
application_consistent_properties: User-defined application-consistent properties for the recovery point.

volume_group_recovery_points

ext_id: recovery point UUID
tenant_id: A globally unique identifier that represents the tenant that owns this entity
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.
consistency_group_ext_id: External identifier of the Consistency group which the entity was part of at the time of recovery point creation.
location_agnostic_id: Location agnostic identifier of the recovery point. This identifier is used to identify the same instances of a recovery point across different sites.
volume_group_ext_id: Volume Group external identifier which is captured as part of this recovery point.
volume_group_categories: Category key-value pairs associated with the volume group at the time of recovery point creation. The category key and value are separated by ‘/’. For example, a category with key ‘dept’ and value ‘hr’ will be represented as ‘dept/hr’.
disk_recovery_points: array of disk recovery points.

disk_recovery_points

disk_recovery_point_ext_id: External identifier of the disk recovery point.
disk_ext_id: External identifier of the disk.

application_consistent_properties

backup_type: The backup type specifies the criteria for identifying the files to be backed up. This property should be specified to the application-consistent recovery points for Windows VMs/agents. The following backup types are supported for the application-consistent recovery points:
- supported values:
  - FULL_BACKUP: - All the files are backed up irrespective of their last backup date/time or state. Also, this backup type updates the backup history of each file that participated in the recovery point. If not explicitly specified, this is the default backup type.
  - COPY_BACKUP: - this backup type does not update the backup history of individual files involved in the recovery point.
should_include_writers: Indicates whether the given set of VSS writers’ UUIDs should be included or excluded from the application consistent recovery point. By default, the value is set to false, indicating that all listed VSS writers’ UUIDs will be excluded.
writers: List of VSS writer UUIDs that are used in an application consistent recovery point. The default values are the system and the registry writer UUIDs.
should_store_vss_metadata: Indicates whether to store the VSS metadata if the user is interested in application-specific backup/restore. The VSS metadata consists of VSS writers and requester metadata details. These are compressed into a cabinet file(.cab file) during a VSS backup operation. This cabinet file must be saved to the backup media during a backup operation, as it is required during the restore operation.
object_type: value: dataprotection.v4.common.VssProperties

See detailed information in Nutanix List Recovery Points V4.

Using getRecoveryPointsV2

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 getRecoveryPointsV2(args: GetRecoveryPointsV2Args, opts?: InvokeOptions): Promise<GetRecoveryPointsV2Result>
function getRecoveryPointsV2Output(args: GetRecoveryPointsV2OutputArgs, opts?: InvokeOptions): Output<GetRecoveryPointsV2Result>

def get_recovery_points_v2(apply: Optional[str] = None,
                           cluster_id: Optional[str] = None,
                           filter: Optional[str] = None,
                           limit: Optional[int] = None,
                           order_by: Optional[str] = None,
                           page: Optional[int] = None,
                           select: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetRecoveryPointsV2Result
def get_recovery_points_v2_output(apply: Optional[pulumi.Input[str]] = None,
                           cluster_id: Optional[pulumi.Input[str]] = None,
                           filter: Optional[pulumi.Input[str]] = None,
                           limit: Optional[pulumi.Input[int]] = None,
                           order_by: Optional[pulumi.Input[str]] = None,
                           page: Optional[pulumi.Input[int]] = None,
                           select: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetRecoveryPointsV2Result]

func LookupRecoveryPointsV2(ctx *Context, args *LookupRecoveryPointsV2Args, opts ...InvokeOption) (*LookupRecoveryPointsV2Result, error)
func LookupRecoveryPointsV2Output(ctx *Context, args *LookupRecoveryPointsV2OutputArgs, opts ...InvokeOption) LookupRecoveryPointsV2ResultOutput

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

public static class GetRecoveryPointsV2 
{
    public static Task<GetRecoveryPointsV2Result> InvokeAsync(GetRecoveryPointsV2Args args, InvokeOptions? opts = null)
    public static Output<GetRecoveryPointsV2Result> Invoke(GetRecoveryPointsV2InvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetRecoveryPointsV2Result> getRecoveryPointsV2(GetRecoveryPointsV2Args args, InvokeOptions options)
public static Output<GetRecoveryPointsV2Result> getRecoveryPointsV2(GetRecoveryPointsV2Args args, InvokeOptions options)

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

The following arguments are supported:

Apply string

ClusterId string

Cluster type from which recovery points must be fetched.

supported values:
AOS (Default)
MST

Filter string

A URL query parameter that allows clients to filter a collection of resources.

The filter can be applied to the following fields:
creationTime
extId
locationAgnosticId

Limit int

A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set.

OrderBy string

A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default

The orderby can be applied to the following fields:
creationTime
expirationTime

Page int

A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results.

Select string

A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the OData V4.01 URL conventions

The select can be applied to the following fields:
creationTime
expirationTime
extId

Apply string

ClusterId string

Cluster type from which recovery points must be fetched.

supported values:
AOS (Default)
MST

Filter string

A URL query parameter that allows clients to filter a collection of resources.

The filter can be applied to the following fields:
creationTime
extId
locationAgnosticId

Limit int

OrderBy string

The orderby can be applied to the following fields:
creationTime
expirationTime

Page int

Select string

The select can be applied to the following fields:
creationTime
expirationTime
extId

apply String

clusterId String

Cluster type from which recovery points must be fetched.

supported values:
AOS (Default)
MST

filter String

A URL query parameter that allows clients to filter a collection of resources.

The filter can be applied to the following fields:
creationTime
extId
locationAgnosticId

limit Integer

orderBy String

The orderby can be applied to the following fields:
creationTime
expirationTime

page Integer

select String

The select can be applied to the following fields:
creationTime
expirationTime
extId

apply string

clusterId string

Cluster type from which recovery points must be fetched.

supported values:
AOS (Default)
MST

filter string

A URL query parameter that allows clients to filter a collection of resources.

The filter can be applied to the following fields:
creationTime
extId
locationAgnosticId

limit number

orderBy string

The orderby can be applied to the following fields:
creationTime
expirationTime

page number

select string

The select can be applied to the following fields:
creationTime
expirationTime
extId

apply str

cluster_id str

Cluster type from which recovery points must be fetched.

supported values:
AOS (Default)
MST

filter str

A URL query parameter that allows clients to filter a collection of resources.

The filter can be applied to the following fields:
creationTime
extId
locationAgnosticId

limit int

order_by str

The orderby can be applied to the following fields:
creationTime
expirationTime

page int

select str

The select can be applied to the following fields:
creationTime
expirationTime
extId

apply String

clusterId String

Cluster type from which recovery points must be fetched.

supported values:
AOS (Default)
MST

filter String

A URL query parameter that allows clients to filter a collection of resources.

The filter can be applied to the following fields:
creationTime
extId
locationAgnosticId

limit Number

orderBy String

The orderby can be applied to the following fields:
creationTime
expirationTime

page Number

select String

The select can be applied to the following fields:
creationTime
expirationTime
extId

getRecoveryPointsV2 Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
RecoveryPoints List<PiersKarsenbarg.Nutanix.Outputs.GetRecoveryPointsV2RecoveryPoint>: List of recovery points.
Apply string
ClusterId string
Filter string
Limit int
OrderBy string
Page int
Select string

Id string: The provider-assigned unique ID for this managed resource.
RecoveryPoints []GetRecoveryPointsV2RecoveryPoint: List of recovery points.
Apply string
ClusterId string
Filter string
Limit int
OrderBy string
Page int
Select string

id String: The provider-assigned unique ID for this managed resource.
recoveryPoints List<GetRecoveryPointsV2RecoveryPoint>: List of recovery points.
apply String
clusterId String
filter String
limit Integer
orderBy String
page Integer
select String