powerscale 1.7.1, Apr 30 25

powerscale 1.7.1 published on Wednesday, Apr 30, 2025 by dell

powerscale.SnapshotRestore

Explore with Pulumi AI

powerscale 1.7.1 published on Wednesday, Apr 30, 2025 by dell

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.powerscale.SnapshotRestore;
import com.pulumi.powerscale.SnapshotRestoreArgs;
import com.pulumi.powerscale.inputs.SnapshotRestoreCloneParamsArgs;
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) {
        // Restore snapshot using clone operation
        var test = new SnapshotRestore("test", SnapshotRestoreArgs.builder()
            .cloneParams(SnapshotRestoreCloneParamsArgs.builder()
                .destination("Path of the destination")
                .snapshot_id("Snapshot ID")
                .source("Path of the snapshot to copy")
                .build())
            .build());

    }
}

resources:
  # Restore snapshot using clone operation
  test:
    type: powerscale:SnapshotRestore
    properties:
      cloneParams:
        destination: Path of the destination
        snapshot_id: Snapshot ID
        source: Path of the snapshot to copy

Create SnapshotRestore Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new SnapshotRestore(name: string, args?: SnapshotRestoreArgs, opts?: CustomResourceOptions);

@overload
def SnapshotRestore(resource_name: str,
                    args: Optional[SnapshotRestoreArgs] = None,
                    opts: Optional[ResourceOptions] = None)

@overload
def SnapshotRestore(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    clone_params: Optional[SnapshotRestoreCloneParamsArgs] = None,
                    copy_params: Optional[SnapshotRestoreCopyParamsArgs] = None,
                    snaprevert_params: Optional[SnapshotRestoreSnaprevertParamsArgs] = None)

func NewSnapshotRestore(ctx *Context, name string, args *SnapshotRestoreArgs, opts ...ResourceOption) (*SnapshotRestore, error)

public SnapshotRestore(string name, SnapshotRestoreArgs? args = null, CustomResourceOptions? opts = null)

public SnapshotRestore(String name, SnapshotRestoreArgs args)
public SnapshotRestore(String name, SnapshotRestoreArgs args, CustomResourceOptions options)

type: powerscale:SnapshotRestore
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args SnapshotRestoreArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args SnapshotRestoreArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args SnapshotRestoreArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SnapshotRestoreArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args SnapshotRestoreArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var snapshotRestoreResource = new Powerscale.SnapshotRestore("snapshotRestoreResource", new()
{
    CloneParams = new Powerscale.Inputs.SnapshotRestoreCloneParamsArgs
    {
        Destination = "string",
        SnapshotId = 0,
        Source = "string",
        Overwrite = false,
    },
    CopyParams = new Powerscale.Inputs.SnapshotRestoreCopyParamsArgs
    {
        Directory = new Powerscale.Inputs.SnapshotRestoreCopyParamsDirectoryArgs
        {
            Destination = "string",
            Source = "string",
            Continue = false,
            Merge = false,
            Overwrite = false,
        },
        File = new Powerscale.Inputs.SnapshotRestoreCopyParamsFileArgs
        {
            Destination = "string",
            Source = "string",
            Overwrite = false,
        },
    },
    SnaprevertParams = new Powerscale.Inputs.SnapshotRestoreSnaprevertParamsArgs
    {
        SnapshotId = 0,
        AllowDup = false,
        JobId = 0,
    },
});

example, err := powerscale.NewSnapshotRestore(ctx, "snapshotRestoreResource", &powerscale.SnapshotRestoreArgs{
	CloneParams: &powerscale.SnapshotRestoreCloneParamsArgs{
		Destination: pulumi.String("string"),
		SnapshotId:  pulumi.Float64(0),
		Source:      pulumi.String("string"),
		Overwrite:   pulumi.Bool(false),
	},
	CopyParams: &powerscale.SnapshotRestoreCopyParamsArgs{
		Directory: &powerscale.SnapshotRestoreCopyParamsDirectoryArgs{
			Destination: pulumi.String("string"),
			Source:      pulumi.String("string"),
			Continue:    pulumi.Bool(false),
			Merge:       pulumi.Bool(false),
			Overwrite:   pulumi.Bool(false),
		},
		File: &powerscale.SnapshotRestoreCopyParamsFileArgs{
			Destination: pulumi.String("string"),
			Source:      pulumi.String("string"),
			Overwrite:   pulumi.Bool(false),
		},
	},
	SnaprevertParams: &powerscale.SnapshotRestoreSnaprevertParamsArgs{
		SnapshotId: pulumi.Float64(0),
		AllowDup:   pulumi.Bool(false),
		JobId:      pulumi.Float64(0),
	},
})

var snapshotRestoreResource = new SnapshotRestore("snapshotRestoreResource", SnapshotRestoreArgs.builder()
    .cloneParams(SnapshotRestoreCloneParamsArgs.builder()
        .destination("string")
        .snapshotId(0)
        .source("string")
        .overwrite(false)
        .build())
    .copyParams(SnapshotRestoreCopyParamsArgs.builder()
        .directory(SnapshotRestoreCopyParamsDirectoryArgs.builder()
            .destination("string")
            .source("string")
            .continue_(false)
            .merge(false)
            .overwrite(false)
            .build())
        .file(SnapshotRestoreCopyParamsFileArgs.builder()
            .destination("string")
            .source("string")
            .overwrite(false)
            .build())
        .build())
    .snaprevertParams(SnapshotRestoreSnaprevertParamsArgs.builder()
        .snapshotId(0)
        .allowDup(false)
        .jobId(0)
        .build())
    .build());

snapshot_restore_resource = powerscale.SnapshotRestore("snapshotRestoreResource",
    clone_params={
        "destination": "string",
        "snapshot_id": 0,
        "source": "string",
        "overwrite": False,
    },
    copy_params={
        "directory": {
            "destination": "string",
            "source": "string",
            "continue_": False,
            "merge": False,
            "overwrite": False,
        },
        "file": {
            "destination": "string",
            "source": "string",
            "overwrite": False,
        },
    },
    snaprevert_params={
        "snapshot_id": 0,
        "allow_dup": False,
        "job_id": 0,
    })

const snapshotRestoreResource = new powerscale.SnapshotRestore("snapshotRestoreResource", {
    cloneParams: {
        destination: "string",
        snapshotId: 0,
        source: "string",
        overwrite: false,
    },
    copyParams: {
        directory: {
            destination: "string",
            source: "string",
            "continue": false,
            merge: false,
            overwrite: false,
        },
        file: {
            destination: "string",
            source: "string",
            overwrite: false,
        },
    },
    snaprevertParams: {
        snapshotId: 0,
        allowDup: false,
        jobId: 0,
    },
});

type: powerscale:SnapshotRestore
properties:
    cloneParams:
        destination: string
        overwrite: false
        snapshotId: 0
        source: string
    copyParams:
        directory:
            continue: false
            destination: string
            merge: false
            overwrite: false
            source: string
        file:
            destination: string
            overwrite: false
            source: string
    snaprevertParams:
        allowDup: false
        jobId: 0
        snapshotId: 0

SnapshotRestore Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The SnapshotRestore resource accepts the following input properties:

CloneParams SnapshotRestoreCloneParams: Specifies properties for a clone operation.
CopyParams SnapshotRestoreCopyParams: Specifies properties for a copy operation.
SnaprevertParams SnapshotRestoreSnaprevertParams: Specifies properties for a snapshot revert job.

CloneParams SnapshotRestoreCloneParamsArgs: Specifies properties for a clone operation.
CopyParams SnapshotRestoreCopyParamsArgs: Specifies properties for a copy operation.
SnaprevertParams SnapshotRestoreSnaprevertParamsArgs: Specifies properties for a snapshot revert job.

cloneParams SnapshotRestoreCloneParams: Specifies properties for a clone operation.
copyParams SnapshotRestoreCopyParams: Specifies properties for a copy operation.
snaprevertParams SnapshotRestoreSnaprevertParams: Specifies properties for a snapshot revert job.

cloneParams SnapshotRestoreCloneParams: Specifies properties for a clone operation.
copyParams SnapshotRestoreCopyParams: Specifies properties for a copy operation.
snaprevertParams SnapshotRestoreSnaprevertParams: Specifies properties for a snapshot revert job.

clone_params SnapshotRestoreCloneParamsArgs: Specifies properties for a clone operation.
copy_params SnapshotRestoreCopyParamsArgs: Specifies properties for a copy operation.
snaprevert_params SnapshotRestoreSnaprevertParamsArgs: Specifies properties for a snapshot revert job.

cloneParams Property Map: Specifies properties for a clone operation.
copyParams Property Map: Specifies properties for a copy operation.
snaprevertParams Property Map: Specifies properties for a snapshot revert job.

Outputs

All input properties are implicitly available as output properties. Additionally, the SnapshotRestore resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing SnapshotRestore Resource

Get an existing SnapshotRestore resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: SnapshotRestoreState, opts?: CustomResourceOptions): SnapshotRestore

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        clone_params: Optional[SnapshotRestoreCloneParamsArgs] = None,
        copy_params: Optional[SnapshotRestoreCopyParamsArgs] = None,
        snaprevert_params: Optional[SnapshotRestoreSnaprevertParamsArgs] = None) -> SnapshotRestore

func GetSnapshotRestore(ctx *Context, name string, id IDInput, state *SnapshotRestoreState, opts ...ResourceOption) (*SnapshotRestore, error)

public static SnapshotRestore Get(string name, Input<string> id, SnapshotRestoreState? state, CustomResourceOptions? opts = null)

public static SnapshotRestore get(String name, Output<String> id, SnapshotRestoreState state, CustomResourceOptions options)

resources:  _:    type: powerscale:SnapshotRestore    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

CloneParams SnapshotRestoreCloneParams: Specifies properties for a clone operation.
CopyParams SnapshotRestoreCopyParams: Specifies properties for a copy operation.
SnaprevertParams SnapshotRestoreSnaprevertParams: Specifies properties for a snapshot revert job.

CloneParams SnapshotRestoreCloneParamsArgs: Specifies properties for a clone operation.
CopyParams SnapshotRestoreCopyParamsArgs: Specifies properties for a copy operation.
SnaprevertParams SnapshotRestoreSnaprevertParamsArgs: Specifies properties for a snapshot revert job.

cloneParams SnapshotRestoreCloneParams: Specifies properties for a clone operation.
copyParams SnapshotRestoreCopyParams: Specifies properties for a copy operation.
snaprevertParams SnapshotRestoreSnaprevertParams: Specifies properties for a snapshot revert job.

cloneParams SnapshotRestoreCloneParams: Specifies properties for a clone operation.
copyParams SnapshotRestoreCopyParams: Specifies properties for a copy operation.
snaprevertParams SnapshotRestoreSnaprevertParams: Specifies properties for a snapshot revert job.

clone_params SnapshotRestoreCloneParamsArgs: Specifies properties for a clone operation.
copy_params SnapshotRestoreCopyParamsArgs: Specifies properties for a copy operation.
snaprevert_params SnapshotRestoreSnaprevertParamsArgs: Specifies properties for a snapshot revert job.

cloneParams Property Map: Specifies properties for a clone operation.
copyParams Property Map: Specifies properties for a copy operation.
snaprevertParams Property Map: Specifies properties for a snapshot revert job.

Supporting Types

SnapshotRestoreCloneParams, SnapshotRestoreCloneParamsArgs

Destination string: Destination of the snapshot, e.g. ifs/dest/test.txt .
SnapshotId double: Snapshot ID.
Source string: Source of the snapshot.
Overwrite bool: Whether or not to overwrite the destination if it already exists.

Destination string: Destination of the snapshot, e.g. ifs/dest/test.txt .
SnapshotId float64: Snapshot ID.
Source string: Source of the snapshot.
Overwrite bool: Whether or not to overwrite the destination if it already exists.

destination String: Destination of the snapshot, e.g. ifs/dest/test.txt .
snapshotId Double: Snapshot ID.
source String: Source of the snapshot.
overwrite Boolean: Whether or not to overwrite the destination if it already exists.

destination string: Destination of the snapshot, e.g. ifs/dest/test.txt .
snapshotId number: Snapshot ID.
source string: Source of the snapshot.
overwrite boolean: Whether or not to overwrite the destination if it already exists.

destination str: Destination of the snapshot, e.g. ifs/dest/test.txt .
snapshot_id float: Snapshot ID.
source str: Source of the snapshot.
overwrite bool: Whether or not to overwrite the destination if it already exists.

destination String: Destination of the snapshot, e.g. ifs/dest/test.txt .
snapshotId Number: Snapshot ID.
source String: Source of the snapshot.
overwrite Boolean: Whether or not to overwrite the destination if it already exists.

SnapshotRestoreCopyParams, SnapshotRestoreCopyParamsArgs

Directory SnapshotRestoreCopyParamsDirectory: Specifies properties for copying directory.
File SnapshotRestoreCopyParamsFile: Specifies properties for copying file.

Directory SnapshotRestoreCopyParamsDirectory: Specifies properties for copying directory.
File SnapshotRestoreCopyParamsFile: Specifies properties for copying file.

directory SnapshotRestoreCopyParamsDirectory: Specifies properties for copying directory.
file SnapshotRestoreCopyParamsFile: Specifies properties for copying file.

directory SnapshotRestoreCopyParamsDirectory: Specifies properties for copying directory.
file SnapshotRestoreCopyParamsFile: Specifies properties for copying file.

directory SnapshotRestoreCopyParamsDirectory: Specifies properties for copying directory.
file SnapshotRestoreCopyParamsFile: Specifies properties for copying file.

directory Property Map: Specifies properties for copying directory.
file Property Map: Specifies properties for copying file.

SnapshotRestoreCopyParamsDirectory, SnapshotRestoreCopyParamsDirectoryArgs

Destination string: Destination of the snapshot, e.g. ifs/dest.
Source string: Source of the snapshot.
Continue bool: Whether or not to continue if the destination already exists.
Merge bool: Whether or not to merge the destination if it already exists.
Overwrite bool: Whether or not to overwrite the destination if it already exists.

Destination string: Destination of the snapshot, e.g. ifs/dest.
Source string: Source of the snapshot.
Continue bool: Whether or not to continue if the destination already exists.
Merge bool: Whether or not to merge the destination if it already exists.
Overwrite bool: Whether or not to overwrite the destination if it already exists.

destination String: Destination of the snapshot, e.g. ifs/dest.
source String: Source of the snapshot.
continue_ Boolean: Whether or not to continue if the destination already exists.
merge Boolean: Whether or not to merge the destination if it already exists.
overwrite Boolean: Whether or not to overwrite the destination if it already exists.

destination string: Destination of the snapshot, e.g. ifs/dest.
source string: Source of the snapshot.
continue boolean: Whether or not to continue if the destination already exists.
merge boolean: Whether or not to merge the destination if it already exists.
overwrite boolean: Whether or not to overwrite the destination if it already exists.

destination str: Destination of the snapshot, e.g. ifs/dest.
source str: Source of the snapshot.
continue_ bool: Whether or not to continue if the destination already exists.
merge bool: Whether or not to merge the destination if it already exists.
overwrite bool: Whether or not to overwrite the destination if it already exists.

destination String: Destination of the snapshot, e.g. ifs/dest.
source String: Source of the snapshot.
continue Boolean: Whether or not to continue if the destination already exists.
merge Boolean: Whether or not to merge the destination if it already exists.
overwrite Boolean: Whether or not to overwrite the destination if it already exists.

SnapshotRestoreCopyParamsFile, SnapshotRestoreCopyParamsFileArgs

Destination string: Destination of the snapshot, e.g. ifs/dest/test.txt .
Source string: Source of the snapshot.
Overwrite bool: Whether or not to overwrite the destination if it already exists.

Destination string: Destination of the snapshot, e.g. ifs/dest/test.txt .
Source string: Source of the snapshot.
Overwrite bool: Whether or not to overwrite the destination if it already exists.

destination String: Destination of the snapshot, e.g. ifs/dest/test.txt .
source String: Source of the snapshot.
overwrite Boolean: Whether or not to overwrite the destination if it already exists.

destination string: Destination of the snapshot, e.g. ifs/dest/test.txt .
source string: Source of the snapshot.
overwrite boolean: Whether or not to overwrite the destination if it already exists.

destination str: Destination of the snapshot, e.g. ifs/dest/test.txt .
source str: Source of the snapshot.
overwrite bool: Whether or not to overwrite the destination if it already exists.

destination String: Destination of the snapshot, e.g. ifs/dest/test.txt .
source String: Source of the snapshot.
overwrite Boolean: Whether or not to overwrite the destination if it already exists.

SnapshotRestoreSnaprevertParams, SnapshotRestoreSnaprevertParamsArgs

SnapshotId double: Snapshot ID.
AllowDup bool: Whether or not to queue the job if one of the same type is already running or queued.
JobId double: Job ID.

SnapshotId float64: Snapshot ID.
AllowDup bool: Whether or not to queue the job if one of the same type is already running or queued.
JobId float64: Job ID.

snapshotId Double: Snapshot ID.
allowDup Boolean: Whether or not to queue the job if one of the same type is already running or queued.
jobId Double: Job ID.

snapshotId number: Snapshot ID.
allowDup boolean: Whether or not to queue the job if one of the same type is already running or queued.
jobId number: Job ID.

snapshot_id float: Snapshot ID.
allow_dup bool: Whether or not to queue the job if one of the same type is already running or queued.
job_id float: Job ID.

snapshotId Number: Snapshot ID.
allowDup Boolean: Whether or not to queue the job if one of the same type is already running or queued.
jobId Number: Job ID.

Package Details

Repository: powerscale dell/terraform-provider-powerscale
License
Notes: This Pulumi package is based on the powerscale Terraform Provider.

powerscale 1.7.1 published on Wednesday, Apr 30, 2025 by dell

dell/terraform-provider-powerscale

powerscale.SnapshotRestore

On this page

On this page

Example Usage

Create SnapshotRestore Resource

Constructor syntax

Parameters

Constructor example

SnapshotRestore Resource Properties

Inputs

Outputs

Look up Existing SnapshotRestore Resource

Supporting Types

SnapshotRestoreCloneParams, SnapshotRestoreCloneParamsArgs

SnapshotRestoreCopyParams, SnapshotRestoreCopyParamsArgs

SnapshotRestoreCopyParamsDirectory, SnapshotRestoreCopyParamsDirectoryArgs

SnapshotRestoreCopyParamsFile, SnapshotRestoreCopyParamsFileArgs

SnapshotRestoreSnaprevertParams, SnapshotRestoreSnaprevertParamsArgs

Package Details

On this page

On this page