Docs Packages
  1. Packages
  2. Nutanix
  3. API Docs
  4. getNdbSnapshots
Nutanix v0.0.52 published on Friday, Jun 7, 2024 by Piers Karsenbarg
pierskarsenbarg/pulumi-nutanix

nutanix.getNdbSnapshots

Explore with Pulumi AI

nutanix logo
Nutanix v0.0.52 published on Friday, Jun 7, 2024 by Piers Karsenbarg
pierskarsenbarg/pulumi-nutanix

    List all snapshots present in Nutanix Database Service

    Example Usage

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

const snaps = nutanix.getNdbSnapshots({
    filters: [{
        timeMachineId: "{{ time_machine_id }}",
    }],
});

    import pulumi
import pulumi_nutanix as nutanix

snaps = nutanix.get_ndb_snapshots(filters=[nutanix.GetNdbSnapshotsFilterArgs(
    time_machine_id="{{ time_machine_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.GetNdbSnapshots(ctx, &nutanix.GetNdbSnapshotsArgs{
			Filters: []nutanix.GetNdbSnapshotsFilter{
				{
					TimeMachineId: pulumi.StringRef("{{ time_machine_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.GetNdbSnapshots.Invoke(new()
    {
        Filters = new[]
        {
            new Nutanix.Inputs.GetNdbSnapshotsFilterInputArgs
            {
                TimeMachineId = "{{ time_machine_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.GetNdbSnapshotsArgs;
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.getNdbSnapshots(GetNdbSnapshotsArgs.builder()
            .filters(GetNdbSnapshotsFilterArgs.builder()
                .timeMachineId("{{ time_machine_id }}")
                .build())
            .build());

    }
}

    variables:
  snaps:
    fn::invoke:
      Function: nutanix:getNdbSnapshots
      Arguments:
        filters:
          - timeMachineId: '{{ time_machine_id }}'

    Attribute Reference

    • snapshots: List of snapshots

    snapshots

    • id: name of snapshot
    • description: description of snapshot
    • properties: properties
    • owner_id: owner id
    • date_created: created date
    • date_modified: modified date
    • properties: properties
    • tags: tags
    • snapshot_uuid: snapshot uuid
    • nx_cluster_id: nx cluster id
    • protection_domain_id: protection domain
    • parent_snapshot_id: parent snapshot id
    • database_node_id: database node id
    • app_info_version: App info version
    • status: status
    • type: type
    • applicable_types: Applicable types
    • snapshot_timestamp: snapshot timeStamp
    • metadata: metadata of snapshot
    • software_snapshot_id: software snapshot id
    • software_database_snapshot: software database snapshot
    • dbserver_storage_metadata_version: dbserver storage metadata version
    • santised_from_snapshot_id: sanitized snapshot id
    • timezone: timezone
    • processed: processed
    • database_snapshot: database snapshot
    • from_timestamp: from timestamp
    • to_timestamp: to timestamp
    • dbserver_id: dbserver id
    • dbserver_name: dbserver name
    • dbserver_ip:dbserver ip
    • replicated_snapshots: replicated snapshots
    • software_snapshot: software snapshot
    • santised_snapshots:santised snapshots
    • snapshot_family: snapshot family
    • snapshot_timestamp_date: snapshot timestamp date
    • lcm_config: LCM config
    • parent_snapshot: parent snapshot
    • snapshot_size: snapshot size

    See detailed information in NDB Snapshots.

    Using getNdbSnapshots

    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 getNdbSnapshots(args: GetNdbSnapshotsArgs, opts?: InvokeOptions): Promise<GetNdbSnapshotsResult>
function getNdbSnapshotsOutput(args: GetNdbSnapshotsOutputArgs, opts?: InvokeOptions): Output<GetNdbSnapshotsResult>
    def get_ndb_snapshots(filters: Optional[Sequence[GetNdbSnapshotsFilter]] = None,
                      opts: Optional[InvokeOptions] = None) -> GetNdbSnapshotsResult
def get_ndb_snapshots_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetNdbSnapshotsFilterArgs]]]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetNdbSnapshotsResult]
    func GetNdbSnapshots(ctx *Context, args *GetNdbSnapshotsArgs, opts ...InvokeOption) (*GetNdbSnapshotsResult, error)
func GetNdbSnapshotsOutput(ctx *Context, args *GetNdbSnapshotsOutputArgs, opts ...InvokeOption) GetNdbSnapshotsResultOutput

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

    public static class GetNdbSnapshots 
{
    public static Task<GetNdbSnapshotsResult> InvokeAsync(GetNdbSnapshotsArgs args, InvokeOptions? opts = null)
    public static Output<GetNdbSnapshotsResult> Invoke(GetNdbSnapshotsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetNdbSnapshotsResult> getNdbSnapshots(GetNdbSnapshotsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

    Filters List<PiersKarsenbarg.Nutanix.Inputs.GetNdbSnapshotsFilter>
    filters help to fetch the snapshots based on input
    Filters []GetNdbSnapshotsFilter
    filters help to fetch the snapshots based on input
    filters List<GetNdbSnapshotsFilter>
    filters help to fetch the snapshots based on input
    filters GetNdbSnapshotsFilter[]
    filters help to fetch the snapshots based on input
    filters Sequence[GetNdbSnapshotsFilter]
    filters help to fetch the snapshots based on input
    filters List<Property Map>
    filters help to fetch the snapshots based on input

    getNdbSnapshots Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Snapshots []GetNdbSnapshotsSnapshot
    Filters []GetNdbSnapshotsFilter
    id String
    The provider-assigned unique ID for this managed resource.
    snapshots List<GetNdbSnapshotsSnapshot>
    filters List<GetNdbSnapshotsFilter>
    id string
    The provider-assigned unique ID for this managed resource.
    snapshots GetNdbSnapshotsSnapshot[]
    filters GetNdbSnapshotsFilter[]
    id str
    The provider-assigned unique ID for this managed resource.
    snapshots Sequence[GetNdbSnapshotsSnapshot]
    filters Sequence[GetNdbSnapshotsFilter]
    id String
    The provider-assigned unique ID for this managed resource.
    snapshots List<Property Map>
    filters List<Property Map>

    Supporting Types

    GetNdbSnapshotsFilter

    TimeMachineId string
    Fetches all the snapshots for a given time machine
    TimeMachineId string
    Fetches all the snapshots for a given time machine
    timeMachineId String
    Fetches all the snapshots for a given time machine
    timeMachineId string
    Fetches all the snapshots for a given time machine
    time_machine_id str
    Fetches all the snapshots for a given time machine
    timeMachineId String
    Fetches all the snapshots for a given time machine

    GetNdbSnapshotsSnapshot

    AppInfoVersion string
    ApplicableTypes List<string>
    DatabaseNodeId string
    DatabaseSnapshot bool
    DateCreated string
    DateModified string
    DbserverId string
    DbserverIp string
    DbserverName string
    DbserverStorageMetadataVersion int
    Description string
    FromTimestamp string
    Id string
    LcmConfigs List<PiersKarsenbarg.Nutanix.Inputs.GetNdbSnapshotsSnapshotLcmConfig>
    Name string
    NxClusterId string
    ParentSnapshot bool
    ParentSnapshotId string
    Processed bool
    Properties List<PiersKarsenbarg.Nutanix.Inputs.GetNdbSnapshotsSnapshotProperty>
    List of all the properties
    ProtectionDomainId string
    ReplicatedSnapshots List<string>
    Santized bool
    SantizedFromSnapshotId string
    SantizedSnapshots string
    SnapshotFamily string
    SnapshotSize double
    SnapshotTimestamp string
    SnapshotTimestampDate int
    SnapshotUuid string
    SoftwareDatabaseSnapshot bool
    SoftwareSnapshot string
    SoftwareSnapshotId string
    Status string
    Tags List<PiersKarsenbarg.Nutanix.Inputs.GetNdbSnapshotsSnapshotTag>
    TimeMachineId string
    Timezone string
    ToTimestamp string
    Type string
    AppInfoVersion string
    ApplicableTypes []string
    DatabaseNodeId string
    DatabaseSnapshot bool
    DateCreated string
    DateModified string
    DbserverId string
    DbserverIp string
    DbserverName string
    DbserverStorageMetadataVersion int
    Description string
    FromTimestamp string
    Id string
    LcmConfigs []GetNdbSnapshotsSnapshotLcmConfig
    Name string
    NxClusterId string
    ParentSnapshot bool
    ParentSnapshotId string
    Processed bool
    Properties []GetNdbSnapshotsSnapshotProperty
    List of all the properties
    ProtectionDomainId string
    ReplicatedSnapshots []string
    Santized bool
    SantizedFromSnapshotId string
    SantizedSnapshots string
    SnapshotFamily string
    SnapshotSize float64
    SnapshotTimestamp string
    SnapshotTimestampDate int
    SnapshotUuid string
    SoftwareDatabaseSnapshot bool
    SoftwareSnapshot string
    SoftwareSnapshotId string
    Status string
    Tags []GetNdbSnapshotsSnapshotTag
    TimeMachineId string
    Timezone string
    ToTimestamp string
    Type string
    appInfoVersion String
    applicableTypes List<String>
    databaseNodeId String
    databaseSnapshot Boolean
    dateCreated String
    dateModified String
    dbserverId String
    dbserverIp String
    dbserverName String
    dbserverStorageMetadataVersion Integer
    description String
    fromTimestamp String
    id String
    lcmConfigs List<GetNdbSnapshotsSnapshotLcmConfig>
    name String
    nxClusterId String
    parentSnapshot Boolean
    parentSnapshotId String
    processed Boolean
    properties List<GetNdbSnapshotsSnapshotProperty>
    List of all the properties
    protectionDomainId String
    replicatedSnapshots List<String>
    santized Boolean
    santizedFromSnapshotId String
    santizedSnapshots String
    snapshotFamily String
    snapshotSize Double
    snapshotTimestamp String
    snapshotTimestampDate Integer
    snapshotUuid String
    softwareDatabaseSnapshot Boolean
    softwareSnapshot String
    softwareSnapshotId String
    status String
    tags List<GetNdbSnapshotsSnapshotTag>
    timeMachineId String
    timezone String
    toTimestamp String
    type String
    appInfoVersion string
    applicableTypes string[]
    databaseNodeId string
    databaseSnapshot boolean
    dateCreated string
    dateModified string
    dbserverId string
    dbserverIp string
    dbserverName string
    dbserverStorageMetadataVersion number
    description string
    fromTimestamp string
    id string
    lcmConfigs GetNdbSnapshotsSnapshotLcmConfig[]
    name string
    nxClusterId string
    parentSnapshot boolean
    parentSnapshotId string
    processed boolean
    properties GetNdbSnapshotsSnapshotProperty[]
    List of all the properties
    protectionDomainId string
    replicatedSnapshots string[]
    santized boolean
    santizedFromSnapshotId string
    santizedSnapshots string
    snapshotFamily string
    snapshotSize number
    snapshotTimestamp string
    snapshotTimestampDate number
    snapshotUuid string
    softwareDatabaseSnapshot boolean
    softwareSnapshot string
    softwareSnapshotId string
    status string
    tags GetNdbSnapshotsSnapshotTag[]
    timeMachineId string
    timezone string
    toTimestamp string
    type string
    app_info_version str
    applicable_types Sequence[str]
    database_node_id str
    database_snapshot bool
    date_created str
    date_modified str
    dbserver_id str
    dbserver_ip str
    dbserver_name str
    dbserver_storage_metadata_version int
    description str
    from_timestamp str
    id str
    lcm_configs Sequence[GetNdbSnapshotsSnapshotLcmConfig]
    name str
    nx_cluster_id str
    parent_snapshot bool
    parent_snapshot_id str
    processed bool
    properties Sequence[GetNdbSnapshotsSnapshotProperty]
    List of all the properties
    protection_domain_id str
    replicated_snapshots Sequence[str]
    santized bool
    santized_from_snapshot_id str
    santized_snapshots str
    snapshot_family str
    snapshot_size float
    snapshot_timestamp str
    snapshot_timestamp_date int
    snapshot_uuid str
    software_database_snapshot bool
    software_snapshot str
    software_snapshot_id str
    status str
    tags Sequence[GetNdbSnapshotsSnapshotTag]
    time_machine_id str
    timezone str
    to_timestamp str
    type str
    appInfoVersion String
    applicableTypes List<String>
    databaseNodeId String
    databaseSnapshot Boolean
    dateCreated String
    dateModified String
    dbserverId String
    dbserverIp String
    dbserverName String
    dbserverStorageMetadataVersion Number
    description String
    fromTimestamp String
    id String
    lcmConfigs List<Property Map>
    name String
    nxClusterId String
    parentSnapshot Boolean
    parentSnapshotId String
    processed Boolean
    properties List<Property Map>
    List of all the properties
    protectionDomainId String
    replicatedSnapshots List<String>
    santized Boolean
    santizedFromSnapshotId String
    santizedSnapshots String
    snapshotFamily String
    snapshotSize Number
    snapshotTimestamp String
    snapshotTimestampDate Number
    snapshotUuid String
    softwareDatabaseSnapshot Boolean
    softwareSnapshot String
    softwareSnapshotId String
    status String
    tags List<Property Map>
    timeMachineId String
    timezone String
    toTimestamp String
    type String

    GetNdbSnapshotsSnapshotLcmConfig

    GetNdbSnapshotsSnapshotLcmConfigExpiryDetail

    GetNdbSnapshotsSnapshotLcmConfigPostDeleteCommand

    Command string
    Command string
    command String
    command string
    command String

    GetNdbSnapshotsSnapshotLcmConfigPreDeleteCommand

    Command string
    Command string
    command String
    command string
    command String

    GetNdbSnapshotsSnapshotLcmConfigRefreshDetail

    GetNdbSnapshotsSnapshotProperty

    Description string
    Name string
    RefId string
    Secure bool
    Value string
    Description string
    Name string
    RefId string
    Secure bool
    Value string
    description String
    name String
    refId String
    secure Boolean
    value String
    description string
    name string
    refId string
    secure boolean
    value string
    description String
    name String
    refId String
    secure Boolean
    value String

    GetNdbSnapshotsSnapshotTag

    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
    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 logo
    Nutanix v0.0.52 published on Friday, Jun 7, 2024 by Piers Karsenbarg
    pierskarsenbarg/pulumi-nutanix