Nutanix v0.7.4, Mar 21 25

Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg

nutanix.getNdbSnapshot

Explore with Pulumi AI

Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const snaps = nutanix.getNdbSnapshot({
    filters: [{
        loadReplicatedChildSnapshots: "true",
    }],
    snapshotId: "{{ snapshot_id }}",
});

import pulumi
import pulumi_nutanix as nutanix

snaps = nutanix.get_ndb_snapshot(filters=[{
        "load_replicated_child_snapshots": "true",
    }],
    snapshot_id="{{ snapshot_id }}")

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.GetNdbSnapshot(ctx, &nutanix.GetNdbSnapshotArgs{
			Filters: []nutanix.GetNdbSnapshotFilter{
				{
					LoadReplicatedChildSnapshots: pulumi.StringRef("true"),
				},
			},
			SnapshotId: "{{ snapshot_id }}",
		}, 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 snaps = Nutanix.GetNdbSnapshot.Invoke(new()
    {
        Filters = new[]
        {
            new Nutanix.Inputs.GetNdbSnapshotFilterInputArgs
            {
                LoadReplicatedChildSnapshots = "true",
            },
        },
        SnapshotId = "{{ snapshot_id }}",
    });

});

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.GetNdbSnapshotArgs;
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 snaps = NutanixFunctions.getNdbSnapshot(GetNdbSnapshotArgs.builder()
            .filters(GetNdbSnapshotFilterArgs.builder()
                .loadReplicatedChildSnapshots(true)
                .build())
            .snapshotId("{{ snapshot_id }}")
            .build());

    }
}

variables:
  snaps:
    fn::invoke:
      function: nutanix:getNdbSnapshot
      arguments:
        filters:
          - loadReplicatedChildSnapshots: true
        snapshotId: '{{ snapshot_id }}'

Using getNdbSnapshot

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.

TypeScript
Python
Go
C#
Java
YAML

function getNdbSnapshot(args: GetNdbSnapshotArgs, opts?: InvokeOptions): Promise<GetNdbSnapshotResult>
function getNdbSnapshotOutput(args: GetNdbSnapshotOutputArgs, opts?: InvokeOptions): Output<GetNdbSnapshotResult>

def get_ndb_snapshot(filters: Optional[Sequence[GetNdbSnapshotFilter]] = None,
                     snapshot_id: Optional[str] = None,
                     tags: Optional[Sequence[GetNdbSnapshotTag]] = None,
                     opts: Optional[InvokeOptions] = None) -> GetNdbSnapshotResult
def get_ndb_snapshot_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetNdbSnapshotFilterArgs]]]] = None,
                     snapshot_id: Optional[pulumi.Input[str]] = None,
                     tags: Optional[pulumi.Input[Sequence[pulumi.Input[GetNdbSnapshotTagArgs]]]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetNdbSnapshotResult]

func GetNdbSnapshot(ctx *Context, args *GetNdbSnapshotArgs, opts ...InvokeOption) (*GetNdbSnapshotResult, error)
func GetNdbSnapshotOutput(ctx *Context, args *GetNdbSnapshotOutputArgs, opts ...InvokeOption) GetNdbSnapshotResultOutput

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

public static class GetNdbSnapshot 
{
    public static Task<GetNdbSnapshotResult> InvokeAsync(GetNdbSnapshotArgs args, InvokeOptions? opts = null)
    public static Output<GetNdbSnapshotResult> Invoke(GetNdbSnapshotInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetNdbSnapshotResult> getNdbSnapshot(GetNdbSnapshotArgs args, InvokeOptions options)
public static Output<GetNdbSnapshotResult> getNdbSnapshot(GetNdbSnapshotArgs args, InvokeOptions options)

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

The following arguments are supported:

SnapshotId string: Snapshot ID to be given
Filters List<PiersKarsenbarg.Nutanix.Inputs.GetNdbSnapshotFilter>: Filters will fetch the snapshot details as per input
Tags List<PiersKarsenbarg.Nutanix.Inputs.GetNdbSnapshotTag>: tags

SnapshotId string: Snapshot ID to be given
Filters []GetNdbSnapshotFilter: Filters will fetch the snapshot details as per input
Tags []GetNdbSnapshotTag: tags

snapshotId String: Snapshot ID to be given
filters List<GetNdbSnapshotFilter>: Filters will fetch the snapshot details as per input
tags List<GetNdbSnapshotTag>: tags

snapshotId string: Snapshot ID to be given
filters GetNdbSnapshotFilter[]: Filters will fetch the snapshot details as per input
tags GetNdbSnapshotTag[]: tags

snapshot_id str: Snapshot ID to be given
filters Sequence[GetNdbSnapshotFilter]: Filters will fetch the snapshot details as per input
tags Sequence[GetNdbSnapshotTag]: tags

snapshotId String: Snapshot ID to be given
filters List<Property Map>: Filters will fetch the snapshot details as per input
tags List<Property Map>: tags

getNdbSnapshot Result

The following output properties are available:

AppInfoVersion string: App info version
ApplicableTypes List<string>: Applicable types
DatabaseNodeId string: database node id
DatabaseSnapshot bool: database snapshot
DateCreated string: created date
DateModified string: modified date
DbserverId string: dbserver id
DbserverIp string: dbserver ip
DbserverName string: dbserver name
DbserverStorageMetadataVersion int: dbserver storage metadata version
Description string: description of snapshot
FromTimestamp string: from timestamp
Id string: name of snapshot
LcmConfigs List<PiersKarsenbarg.Nutanix.Outputs.GetNdbSnapshotLcmConfig>: LCM config
Name string
NxClusterId string: nx cluster id
ParentSnapshot bool: parent snapshot
ParentSnapshotId string: parent snapshot id
Processed bool: processed
Properties List<PiersKarsenbarg.Nutanix.Outputs.GetNdbSnapshotProperty>: properties
ProtectionDomainId string: protection domain
ReplicatedSnapshots List<string>: replicated snapshots
Santized bool
SantizedFromSnapshotId string
SantizedSnapshots string
SnapshotFamily string: snapshot family
SnapshotId string
SnapshotSize double: snapshot size
SnapshotTimestamp string: snapshot timeStamp
SnapshotTimestampDate int: snapshot timestamp date
SnapshotUuid string: snapshot uuid
SoftwareDatabaseSnapshot bool: software database snapshot
SoftwareSnapshot string: software snapshot
SoftwareSnapshotId string: software snapshot id
Status string: status
Tags List<PiersKarsenbarg.Nutanix.Outputs.GetNdbSnapshotTag>: tags
TimeMachineId string
Timezone string: timezone
ToTimestamp string: to timestamp
Type string: type
Filters List<PiersKarsenbarg.Nutanix.Outputs.GetNdbSnapshotFilter>

AppInfoVersion string: App info version
ApplicableTypes []string: Applicable types
DatabaseNodeId string: database node id
DatabaseSnapshot bool: database snapshot
DateCreated string: created date
DateModified string: modified date
DbserverId string: dbserver id
DbserverIp string: dbserver ip
DbserverName string: dbserver name
DbserverStorageMetadataVersion int: dbserver storage metadata version
Description string: description of snapshot
FromTimestamp string: from timestamp
Id string: name of snapshot
LcmConfigs []GetNdbSnapshotLcmConfig: LCM config
Name string
NxClusterId string: nx cluster id
ParentSnapshot bool: parent snapshot
ParentSnapshotId string: parent snapshot id
Processed bool: processed
Properties []GetNdbSnapshotProperty: properties
ProtectionDomainId string: protection domain
ReplicatedSnapshots []string: replicated snapshots
Santized bool
SantizedFromSnapshotId string
SantizedSnapshots string
SnapshotFamily string: snapshot family
SnapshotId string
SnapshotSize float64: snapshot size
SnapshotTimestamp string: snapshot timeStamp
SnapshotTimestampDate int: snapshot timestamp date
SnapshotUuid string: snapshot uuid
SoftwareDatabaseSnapshot bool: software database snapshot
SoftwareSnapshot string: software snapshot
SoftwareSnapshotId string: software snapshot id
Status string: status
Tags []GetNdbSnapshotTag: tags
TimeMachineId string
Timezone string: timezone
ToTimestamp string: to timestamp
Type string: type
Filters []GetNdbSnapshotFilter

appInfoVersion String: App info version
applicableTypes List<String>: Applicable types
databaseNodeId String: database node id
databaseSnapshot Boolean: database snapshot
dateCreated String: created date
dateModified String: modified date
dbserverId String: dbserver id
dbserverIp String: dbserver ip
dbserverName String: dbserver name
dbserverStorageMetadataVersion Integer: dbserver storage metadata version
description String: description of snapshot
fromTimestamp String: from timestamp
id String: name of snapshot
lcmConfigs List<GetNdbSnapshotLcmConfig>: LCM config
name String
nxClusterId String: nx cluster id
parentSnapshot Boolean: parent snapshot
parentSnapshotId String: parent snapshot id
processed Boolean: processed
properties List<GetNdbSnapshotProperty>: properties
protectionDomainId String: protection domain
replicatedSnapshots List<String>: replicated snapshots
santized Boolean
santizedFromSnapshotId String
santizedSnapshots String
snapshotFamily String: snapshot family
snapshotId String
snapshotSize Double: snapshot size
snapshotTimestamp String: snapshot timeStamp
snapshotTimestampDate Integer: snapshot timestamp date
snapshotUuid String: snapshot uuid
softwareDatabaseSnapshot Boolean: software database snapshot
softwareSnapshot String: software snapshot
softwareSnapshotId String: software snapshot id
status String: status
tags List<GetNdbSnapshotTag>: tags
timeMachineId String
timezone String: timezone
toTimestamp String: to timestamp
type String: type
filters List<GetNdbSnapshotFilter>

appInfoVersion string: App info version
applicableTypes string[]: Applicable types
databaseNodeId string: database node id
databaseSnapshot boolean: database snapshot
dateCreated string: created date
dateModified string: modified date
dbserverId string: dbserver id
dbserverIp string: dbserver ip
dbserverName string: dbserver name
dbserverStorageMetadataVersion number: dbserver storage metadata version
description string: description of snapshot
fromTimestamp string: from timestamp
id string: name of snapshot
lcmConfigs GetNdbSnapshotLcmConfig[]: LCM config
name string
nxClusterId string: nx cluster id
parentSnapshot boolean: parent snapshot
parentSnapshotId string: parent snapshot id
processed boolean: processed
properties GetNdbSnapshotProperty[]: properties
protectionDomainId string: protection domain
replicatedSnapshots string[]: replicated snapshots
santized boolean
santizedFromSnapshotId string
santizedSnapshots string
snapshotFamily string: snapshot family
snapshotId string
snapshotSize number: snapshot size
snapshotTimestamp string: snapshot timeStamp
snapshotTimestampDate number: snapshot timestamp date
snapshotUuid string: snapshot uuid
softwareDatabaseSnapshot boolean: software database snapshot
softwareSnapshot string: software snapshot
softwareSnapshotId string: software snapshot id
status string: status
tags GetNdbSnapshotTag[]: tags
timeMachineId string
timezone string: timezone
toTimestamp string: to timestamp
type string: type
filters GetNdbSnapshotFilter[]

app_info_version str: App info version
applicable_types Sequence[str]: Applicable types
database_node_id str: database node id
database_snapshot bool: database snapshot
date_created str: created date
date_modified str: modified date
dbserver_id str: dbserver id
dbserver_ip str: dbserver ip
dbserver_name str: dbserver name
dbserver_storage_metadata_version int: dbserver storage metadata version
description str: description of snapshot
from_timestamp str: from timestamp
id str: name of snapshot
lcm_configs Sequence[GetNdbSnapshotLcmConfig]: LCM config
name str
nx_cluster_id str: nx cluster id
parent_snapshot bool: parent snapshot
parent_snapshot_id str: parent snapshot id
processed bool: processed
properties Sequence[GetNdbSnapshotProperty]: properties
protection_domain_id str: protection domain
replicated_snapshots Sequence[str]: replicated snapshots
santized bool
santized_from_snapshot_id str
santized_snapshots str
snapshot_family str: snapshot family
snapshot_id str
snapshot_size float: snapshot size
snapshot_timestamp str: snapshot timeStamp
snapshot_timestamp_date int: snapshot timestamp date
snapshot_uuid str: snapshot uuid
software_database_snapshot bool: software database snapshot
software_snapshot str: software snapshot
software_snapshot_id str: software snapshot id
status str: status
tags Sequence[GetNdbSnapshotTag]: tags
time_machine_id str
timezone str: timezone
to_timestamp str: to timestamp
type str: type
filters Sequence[GetNdbSnapshotFilter]

appInfoVersion String: App info version
applicableTypes List<String>: Applicable types
databaseNodeId String: database node id
databaseSnapshot Boolean: database snapshot
dateCreated String: created date
dateModified String: modified date
dbserverId String: dbserver id
dbserverIp String: dbserver ip
dbserverName String: dbserver name
dbserverStorageMetadataVersion Number: dbserver storage metadata version
description String: description of snapshot
fromTimestamp String: from timestamp
id String: name of snapshot
lcmConfigs List<Property Map>: LCM config
name String
nxClusterId String: nx cluster id
parentSnapshot Boolean: parent snapshot
parentSnapshotId String: parent snapshot id
processed Boolean: processed
properties List<Property Map>: properties
protectionDomainId String: protection domain
replicatedSnapshots List<String>: replicated snapshots
santized Boolean
santizedFromSnapshotId String
santizedSnapshots String
snapshotFamily String: snapshot family
snapshotId String
snapshotSize Number: snapshot size
snapshotTimestamp String: snapshot timeStamp
snapshotTimestampDate Number: snapshot timestamp date
snapshotUuid String: snapshot uuid
softwareDatabaseSnapshot Boolean: software database snapshot
softwareSnapshot String: software snapshot
softwareSnapshotId String: software snapshot id
status String: status
tags List<Property Map>: tags
timeMachineId String
timezone String: timezone
toTimestamp String: to timestamp
type String: type
filters List<Property Map>

Supporting Types

GetNdbSnapshotFilter

LoadReplicatedChildSnapshots string: load child snapshots. Default is false
Timezone string: Default is UTC

LoadReplicatedChildSnapshots string: load child snapshots. Default is false
Timezone string: Default is UTC

loadReplicatedChildSnapshots String: load child snapshots. Default is false
timezone String: Default is UTC

loadReplicatedChildSnapshots string: load child snapshots. Default is false
timezone string: Default is UTC

load_replicated_child_snapshots str: load child snapshots. Default is false
timezone str: Default is UTC

loadReplicatedChildSnapshots String: load child snapshots. Default is false
timezone String: Default is UTC

GetNdbSnapshotProperty

Description string: description of snapshot
Name string
RefId string
Secure bool
Value string

Description string: description of snapshot
Name string
RefId string
Secure bool
Value string

description String: description of snapshot
name String
refId String
secure Boolean
value String

description string: description of snapshot
name string
refId string
secure boolean
value string

description str: description of snapshot
name str
ref_id str
secure bool
value str

description String: description of snapshot
name String
refId String
secure Boolean
value String

GetNdbSnapshotTag

EntityId string
EntityType string
TagId string
TagName string
Value string

EntityId string
EntityType string
TagId string
TagName string
Value string

entityId String
entityType String
tagId String
tagName String
value String

entityId string
entityType string
tagId string
tagName string
value string

entity_id str
entity_type str
tag_id str
tag_name str
value str

entityId String
entityType String
tagId String
tagName String
value String

Package Details

Repository: nutanix pierskarsenbarg/pulumi-nutanix
License: Apache-2.0
Notes: This Pulumi package is based on the nutanix Terraform Provider.

Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg

pierskarsenbarg/pulumi-nutanix

nutanix.getNdbSnapshot

On this page

On this page

Example Usage

Using getNdbSnapshot

getNdbSnapshot Result

Supporting Types

GetNdbSnapshotFilter

GetNdbSnapshotLcmConfig

GetNdbSnapshotLcmConfigExpiryDetail

GetNdbSnapshotLcmConfigPostDeleteCommand

GetNdbSnapshotLcmConfigPreDeleteCommand

GetNdbSnapshotLcmConfigRefreshDetail

GetNdbSnapshotProperty

GetNdbSnapshotTag

Package Details

On this page

On this page