netapp-cloudmanager.Snapmirror
Explore with Pulumi AI
Provides a netapp-cloudmanager_snapmirror resource. This can be used to create a new snapmirror relationship from any CVO to any CVO, any CVO to ONPREM, ONPREM to any CVO, CVO to FSX. Requires existence of a Cloud Manager Connector and a Cloud Volumes ONTAP system.
Example Usage
S
Create netapp-cloudmanager_snapmirror:
import * as pulumi from "@pulumi/pulumi";
import * as netapp_cloudmanager from "@pulumi/netapp-cloudmanager";
const cl_snapmirror = new netapp_cloudmanager.Snapmirror("cl-snapmirror", {
sourceWorkingEnvironmentId: "xxxxxxxx",
destinationWorkingEnvironmentId: "xxxxxxxx",
sourceVolumeName: "source",
sourceSvmName: "svm_source",
destinationVolumeName: "source_copy",
destinationSvmName: "svm_dest",
policy: "MirrorAllSnapshots",
schedule: "5min",
destinationAggregateName: "aggr1",
maxTransferRate: 102400,
clientId: "xxxxxxxxxxx",
}, {
provider: netapp_cloudmanager,
});
import pulumi
import pulumi_netapp_cloudmanager as netapp_cloudmanager
cl_snapmirror = netapp_cloudmanager.Snapmirror("cl-snapmirror",
source_working_environment_id="xxxxxxxx",
destination_working_environment_id="xxxxxxxx",
source_volume_name="source",
source_svm_name="svm_source",
destination_volume_name="source_copy",
destination_svm_name="svm_dest",
policy="MirrorAllSnapshots",
schedule="5min",
destination_aggregate_name="aggr1",
max_transfer_rate=102400,
client_id="xxxxxxxxxxx",
opts = pulumi.ResourceOptions(provider=netapp_cloudmanager))
package main
import (
netappcloudmanager "github.com/pulumi/pulumi-terraform-provider/sdks/go/netapp-cloudmanager/v25/netapp-cloudmanager"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := netappcloudmanager.NewSnapmirror(ctx, "cl-snapmirror", &netappcloudmanager.SnapmirrorArgs{
SourceWorkingEnvironmentId: pulumi.String("xxxxxxxx"),
DestinationWorkingEnvironmentId: pulumi.String("xxxxxxxx"),
SourceVolumeName: pulumi.String("source"),
SourceSvmName: pulumi.String("svm_source"),
DestinationVolumeName: pulumi.String("source_copy"),
DestinationSvmName: pulumi.String("svm_dest"),
Policy: pulumi.String("MirrorAllSnapshots"),
Schedule: pulumi.String("5min"),
DestinationAggregateName: pulumi.String("aggr1"),
MaxTransferRate: pulumi.Float64(102400),
ClientId: pulumi.String("xxxxxxxxxxx"),
}, pulumi.Provider(netapp_cloudmanager))
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using NetappCloudmanager = Pulumi.NetappCloudmanager;
return await Deployment.RunAsync(() =>
{
var cl_snapmirror = new NetappCloudmanager.Snapmirror("cl-snapmirror", new()
{
SourceWorkingEnvironmentId = "xxxxxxxx",
DestinationWorkingEnvironmentId = "xxxxxxxx",
SourceVolumeName = "source",
SourceSvmName = "svm_source",
DestinationVolumeName = "source_copy",
DestinationSvmName = "svm_dest",
Policy = "MirrorAllSnapshots",
Schedule = "5min",
DestinationAggregateName = "aggr1",
MaxTransferRate = 102400,
ClientId = "xxxxxxxxxxx",
}, new CustomResourceOptions
{
Provider = netapp_cloudmanager,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.netappcloudmanager.Snapmirror;
import com.pulumi.netappcloudmanager.SnapmirrorArgs;
import com.pulumi.resources.CustomResourceOptions;
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) {
var cl_snapmirror = new Snapmirror("cl-snapmirror", SnapmirrorArgs.builder()
.sourceWorkingEnvironmentId("xxxxxxxx")
.destinationWorkingEnvironmentId("xxxxxxxx")
.sourceVolumeName("source")
.sourceSvmName("svm_source")
.destinationVolumeName("source_copy")
.destinationSvmName("svm_dest")
.policy("MirrorAllSnapshots")
.schedule("5min")
.destinationAggregateName("aggr1")
.maxTransferRate("102400")
.clientId("xxxxxxxxxxx")
.build(), CustomResourceOptions.builder()
.provider(netapp_cloudmanager)
.build());
}
}
resources:
cl-snapmirror:
type: netapp-cloudmanager:Snapmirror
properties:
sourceWorkingEnvironmentId: xxxxxxxx
destinationWorkingEnvironmentId: xxxxxxxx
sourceVolumeName: source
sourceSvmName: svm_source
destinationVolumeName: source_copy
destinationSvmName: svm_dest
policy: MirrorAllSnapshots
schedule: 5min
destinationAggregateName: aggr1
maxTransferRate: '102400'
clientId: xxxxxxxxxxx
options:
provider: ${["netapp-cloudmanager"]}
Create Snapmirror Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Snapmirror(name: string, args: SnapmirrorArgs, opts?: CustomResourceOptions);
@overload
def Snapmirror(resource_name: str,
args: SnapmirrorArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Snapmirror(resource_name: str,
opts: Optional[ResourceOptions] = None,
destination_volume_name: Optional[str] = None,
client_id: Optional[str] = None,
source_volume_name: Optional[str] = None,
max_transfer_rate: Optional[float] = None,
provider_volume_type: Optional[str] = None,
destination_svm_name: Optional[str] = None,
deployment_mode: Optional[str] = None,
destination_working_environment_id: Optional[str] = None,
destination_working_environment_name: Optional[str] = None,
iops: Optional[float] = None,
capacity_tier: Optional[str] = None,
policy: Optional[str] = None,
destination_aggregate_name: Optional[str] = None,
schedule: Optional[str] = None,
snapmirror_id: Optional[str] = None,
source_svm_name: Optional[str] = None,
connector_ip: Optional[str] = None,
source_working_environment_id: Optional[str] = None,
source_working_environment_name: Optional[str] = None,
tenant_id: Optional[str] = None,
throughput: Optional[float] = None)
func NewSnapmirror(ctx *Context, name string, args SnapmirrorArgs, opts ...ResourceOption) (*Snapmirror, error)
public Snapmirror(string name, SnapmirrorArgs args, CustomResourceOptions? opts = null)
public Snapmirror(String name, SnapmirrorArgs args)
public Snapmirror(String name, SnapmirrorArgs args, CustomResourceOptions options)
type: netapp-cloudmanager:Snapmirror
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 SnapmirrorArgs
- 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 SnapmirrorArgs
- 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 SnapmirrorArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SnapmirrorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SnapmirrorArgs
- 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 snapmirrorResource = new NetappCloudmanager.Snapmirror("snapmirrorResource", new()
{
DestinationVolumeName = "string",
ClientId = "string",
SourceVolumeName = "string",
MaxTransferRate = 0,
ProviderVolumeType = "string",
DestinationSvmName = "string",
DeploymentMode = "string",
DestinationWorkingEnvironmentId = "string",
DestinationWorkingEnvironmentName = "string",
Iops = 0,
CapacityTier = "string",
Policy = "string",
DestinationAggregateName = "string",
Schedule = "string",
SnapmirrorId = "string",
SourceSvmName = "string",
ConnectorIp = "string",
SourceWorkingEnvironmentId = "string",
SourceWorkingEnvironmentName = "string",
TenantId = "string",
Throughput = 0,
});
example, err := netappcloudmanager.NewSnapmirror(ctx, "snapmirrorResource", &netappcloudmanager.SnapmirrorArgs{
DestinationVolumeName: pulumi.String("string"),
ClientId: pulumi.String("string"),
SourceVolumeName: pulumi.String("string"),
MaxTransferRate: pulumi.Float64(0),
ProviderVolumeType: pulumi.String("string"),
DestinationSvmName: pulumi.String("string"),
DeploymentMode: pulumi.String("string"),
DestinationWorkingEnvironmentId: pulumi.String("string"),
DestinationWorkingEnvironmentName: pulumi.String("string"),
Iops: pulumi.Float64(0),
CapacityTier: pulumi.String("string"),
Policy: pulumi.String("string"),
DestinationAggregateName: pulumi.String("string"),
Schedule: pulumi.String("string"),
SnapmirrorId: pulumi.String("string"),
SourceSvmName: pulumi.String("string"),
ConnectorIp: pulumi.String("string"),
SourceWorkingEnvironmentId: pulumi.String("string"),
SourceWorkingEnvironmentName: pulumi.String("string"),
TenantId: pulumi.String("string"),
Throughput: pulumi.Float64(0),
})
var snapmirrorResource = new Snapmirror("snapmirrorResource", SnapmirrorArgs.builder()
.destinationVolumeName("string")
.clientId("string")
.sourceVolumeName("string")
.maxTransferRate(0)
.providerVolumeType("string")
.destinationSvmName("string")
.deploymentMode("string")
.destinationWorkingEnvironmentId("string")
.destinationWorkingEnvironmentName("string")
.iops(0)
.capacityTier("string")
.policy("string")
.destinationAggregateName("string")
.schedule("string")
.snapmirrorId("string")
.sourceSvmName("string")
.connectorIp("string")
.sourceWorkingEnvironmentId("string")
.sourceWorkingEnvironmentName("string")
.tenantId("string")
.throughput(0)
.build());
snapmirror_resource = netapp_cloudmanager.Snapmirror("snapmirrorResource",
destination_volume_name="string",
client_id="string",
source_volume_name="string",
max_transfer_rate=0,
provider_volume_type="string",
destination_svm_name="string",
deployment_mode="string",
destination_working_environment_id="string",
destination_working_environment_name="string",
iops=0,
capacity_tier="string",
policy="string",
destination_aggregate_name="string",
schedule="string",
snapmirror_id="string",
source_svm_name="string",
connector_ip="string",
source_working_environment_id="string",
source_working_environment_name="string",
tenant_id="string",
throughput=0)
const snapmirrorResource = new netapp_cloudmanager.Snapmirror("snapmirrorResource", {
destinationVolumeName: "string",
clientId: "string",
sourceVolumeName: "string",
maxTransferRate: 0,
providerVolumeType: "string",
destinationSvmName: "string",
deploymentMode: "string",
destinationWorkingEnvironmentId: "string",
destinationWorkingEnvironmentName: "string",
iops: 0,
capacityTier: "string",
policy: "string",
destinationAggregateName: "string",
schedule: "string",
snapmirrorId: "string",
sourceSvmName: "string",
connectorIp: "string",
sourceWorkingEnvironmentId: "string",
sourceWorkingEnvironmentName: "string",
tenantId: "string",
throughput: 0,
});
type: netapp-cloudmanager:Snapmirror
properties:
capacityTier: string
clientId: string
connectorIp: string
deploymentMode: string
destinationAggregateName: string
destinationSvmName: string
destinationVolumeName: string
destinationWorkingEnvironmentId: string
destinationWorkingEnvironmentName: string
iops: 0
maxTransferRate: 0
policy: string
providerVolumeType: string
schedule: string
snapmirrorId: string
sourceSvmName: string
sourceVolumeName: string
sourceWorkingEnvironmentId: string
sourceWorkingEnvironmentName: string
tenantId: string
throughput: 0
Snapmirror 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 Snapmirror resource accepts the following input properties:
- Client
Id string - The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
- Destination
Volume stringName - The name of the destination volume to be created for snapmirror relationship.
- Source
Volume stringName - The name of the source volume.
- Capacity
Tier string - The volume's capacity tier for tiering cold data to object storage: ['S3', 'Blob', 'cloudStorage']. The default values for each cloud provider are as follows: Amazon => 'S3', Azure => 'Blob', GCP => 'cloudStorage'. If none, the capacity tier won't be set on volume creation.
- Connector
Ip string - The private IP of the connector, this is only required for Restricted mode account.
- Deployment
Mode string - The mode of deployment to use for the working environment: ['Standard', 'Restricted']. The default is 'Standard'. To know more on deployment modes https://docs.netapp.com/us-en/bluexp-setup-admin/concept-modes.html/.
- Destination
Aggregate stringName - The aggregate in which the volume will be created. If not provided, Cloud Manager chooses the best aggregate for you.
- Destination
Svm stringName - The name of the destination SVM. The default SVM name is used, if a name isn't provided.
- Destination
Working stringEnvironment Id - The public ID of the destination working environment where the snapmirror relationship will be created.
- Destination
Working stringEnvironment Name - The destination working environment name where the snapmirror relationship will be created. It will be ignored if working_environment_id is provided.
- Iops double
- Max
Transfer doubleRate - Maximum transfer rate limit (KB/s). Use 0 for no limit, otherwise use number between 1024 and 2,147,482,624. The default is 100000.
- Policy string
- The SnapMirror policy name. The default is 'MirrorAllSnapshots'.
- Provider
Volume stringType - The underlying cloud provider volume type. For AWS: ['gp3', 'gp2', 'io1', 'st1', 'sc1']. For Azure: ['Premium_LRS','Standard_LRS','StandardSSD_LRS']. For GCP: ['pd-balanced', 'pd-ssd','pd-standard']
- Schedule string
- Schedule name. The default is '1hour'.
- Snapmirror
Id string - will be the snapmirror name.
- Source
Svm stringName - The name of the source SVM. The default SVM name is used, if a name isn't provided.
- Source
Working stringEnvironment Id - The public ID of the source working environment where the snapmirror relationship will be created.
- Source
Working stringEnvironment Name - The source working environment name where the snapmirror relationship will be created. It will be ignored if working_environment_id is provided.
- Tenant
Id string - The NetApp tenant ID that the Connector will be associated with. To be used in FSX or when
deployment_mode
isRestricted
. You can find the tenant ID in the Identity & Access Management in Settings, Organization tab of BlueXP at https://console.bluexp.netapp.com/. - Throughput double
- Client
Id string - The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
- Destination
Volume stringName - The name of the destination volume to be created for snapmirror relationship.
- Source
Volume stringName - The name of the source volume.
- Capacity
Tier string - The volume's capacity tier for tiering cold data to object storage: ['S3', 'Blob', 'cloudStorage']. The default values for each cloud provider are as follows: Amazon => 'S3', Azure => 'Blob', GCP => 'cloudStorage'. If none, the capacity tier won't be set on volume creation.
- Connector
Ip string - The private IP of the connector, this is only required for Restricted mode account.
- Deployment
Mode string - The mode of deployment to use for the working environment: ['Standard', 'Restricted']. The default is 'Standard'. To know more on deployment modes https://docs.netapp.com/us-en/bluexp-setup-admin/concept-modes.html/.
- Destination
Aggregate stringName - The aggregate in which the volume will be created. If not provided, Cloud Manager chooses the best aggregate for you.
- Destination
Svm stringName - The name of the destination SVM. The default SVM name is used, if a name isn't provided.
- Destination
Working stringEnvironment Id - The public ID of the destination working environment where the snapmirror relationship will be created.
- Destination
Working stringEnvironment Name - The destination working environment name where the snapmirror relationship will be created. It will be ignored if working_environment_id is provided.
- Iops float64
- Max
Transfer float64Rate - Maximum transfer rate limit (KB/s). Use 0 for no limit, otherwise use number between 1024 and 2,147,482,624. The default is 100000.
- Policy string
- The SnapMirror policy name. The default is 'MirrorAllSnapshots'.
- Provider
Volume stringType - The underlying cloud provider volume type. For AWS: ['gp3', 'gp2', 'io1', 'st1', 'sc1']. For Azure: ['Premium_LRS','Standard_LRS','StandardSSD_LRS']. For GCP: ['pd-balanced', 'pd-ssd','pd-standard']
- Schedule string
- Schedule name. The default is '1hour'.
- Snapmirror
Id string - will be the snapmirror name.
- Source
Svm stringName - The name of the source SVM. The default SVM name is used, if a name isn't provided.
- Source
Working stringEnvironment Id - The public ID of the source working environment where the snapmirror relationship will be created.
- Source
Working stringEnvironment Name - The source working environment name where the snapmirror relationship will be created. It will be ignored if working_environment_id is provided.
- Tenant
Id string - The NetApp tenant ID that the Connector will be associated with. To be used in FSX or when
deployment_mode
isRestricted
. You can find the tenant ID in the Identity & Access Management in Settings, Organization tab of BlueXP at https://console.bluexp.netapp.com/. - Throughput float64
- client
Id String - The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
- destination
Volume StringName - The name of the destination volume to be created for snapmirror relationship.
- source
Volume StringName - The name of the source volume.
- capacity
Tier String - The volume's capacity tier for tiering cold data to object storage: ['S3', 'Blob', 'cloudStorage']. The default values for each cloud provider are as follows: Amazon => 'S3', Azure => 'Blob', GCP => 'cloudStorage'. If none, the capacity tier won't be set on volume creation.
- connector
Ip String - The private IP of the connector, this is only required for Restricted mode account.
- deployment
Mode String - The mode of deployment to use for the working environment: ['Standard', 'Restricted']. The default is 'Standard'. To know more on deployment modes https://docs.netapp.com/us-en/bluexp-setup-admin/concept-modes.html/.
- destination
Aggregate StringName - The aggregate in which the volume will be created. If not provided, Cloud Manager chooses the best aggregate for you.
- destination
Svm StringName - The name of the destination SVM. The default SVM name is used, if a name isn't provided.
- destination
Working StringEnvironment Id - The public ID of the destination working environment where the snapmirror relationship will be created.
- destination
Working StringEnvironment Name - The destination working environment name where the snapmirror relationship will be created. It will be ignored if working_environment_id is provided.
- iops Double
- max
Transfer DoubleRate - Maximum transfer rate limit (KB/s). Use 0 for no limit, otherwise use number between 1024 and 2,147,482,624. The default is 100000.
- policy String
- The SnapMirror policy name. The default is 'MirrorAllSnapshots'.
- provider
Volume StringType - The underlying cloud provider volume type. For AWS: ['gp3', 'gp2', 'io1', 'st1', 'sc1']. For Azure: ['Premium_LRS','Standard_LRS','StandardSSD_LRS']. For GCP: ['pd-balanced', 'pd-ssd','pd-standard']
- schedule String
- Schedule name. The default is '1hour'.
- snapmirror
Id String - will be the snapmirror name.
- source
Svm StringName - The name of the source SVM. The default SVM name is used, if a name isn't provided.
- source
Working StringEnvironment Id - The public ID of the source working environment where the snapmirror relationship will be created.
- source
Working StringEnvironment Name - The source working environment name where the snapmirror relationship will be created. It will be ignored if working_environment_id is provided.
- tenant
Id String - The NetApp tenant ID that the Connector will be associated with. To be used in FSX or when
deployment_mode
isRestricted
. You can find the tenant ID in the Identity & Access Management in Settings, Organization tab of BlueXP at https://console.bluexp.netapp.com/. - throughput Double
- client
Id string - The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
- destination
Volume stringName - The name of the destination volume to be created for snapmirror relationship.
- source
Volume stringName - The name of the source volume.
- capacity
Tier string - The volume's capacity tier for tiering cold data to object storage: ['S3', 'Blob', 'cloudStorage']. The default values for each cloud provider are as follows: Amazon => 'S3', Azure => 'Blob', GCP => 'cloudStorage'. If none, the capacity tier won't be set on volume creation.
- connector
Ip string - The private IP of the connector, this is only required for Restricted mode account.
- deployment
Mode string - The mode of deployment to use for the working environment: ['Standard', 'Restricted']. The default is 'Standard'. To know more on deployment modes https://docs.netapp.com/us-en/bluexp-setup-admin/concept-modes.html/.
- destination
Aggregate stringName - The aggregate in which the volume will be created. If not provided, Cloud Manager chooses the best aggregate for you.
- destination
Svm stringName - The name of the destination SVM. The default SVM name is used, if a name isn't provided.
- destination
Working stringEnvironment Id - The public ID of the destination working environment where the snapmirror relationship will be created.
- destination
Working stringEnvironment Name - The destination working environment name where the snapmirror relationship will be created. It will be ignored if working_environment_id is provided.
- iops number
- max
Transfer numberRate - Maximum transfer rate limit (KB/s). Use 0 for no limit, otherwise use number between 1024 and 2,147,482,624. The default is 100000.
- policy string
- The SnapMirror policy name. The default is 'MirrorAllSnapshots'.
- provider
Volume stringType - The underlying cloud provider volume type. For AWS: ['gp3', 'gp2', 'io1', 'st1', 'sc1']. For Azure: ['Premium_LRS','Standard_LRS','StandardSSD_LRS']. For GCP: ['pd-balanced', 'pd-ssd','pd-standard']
- schedule string
- Schedule name. The default is '1hour'.
- snapmirror
Id string - will be the snapmirror name.
- source
Svm stringName - The name of the source SVM. The default SVM name is used, if a name isn't provided.
- source
Working stringEnvironment Id - The public ID of the source working environment where the snapmirror relationship will be created.
- source
Working stringEnvironment Name - The source working environment name where the snapmirror relationship will be created. It will be ignored if working_environment_id is provided.
- tenant
Id string - The NetApp tenant ID that the Connector will be associated with. To be used in FSX or when
deployment_mode
isRestricted
. You can find the tenant ID in the Identity & Access Management in Settings, Organization tab of BlueXP at https://console.bluexp.netapp.com/. - throughput number
- client_
id str - The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
- destination_
volume_ strname - The name of the destination volume to be created for snapmirror relationship.
- source_
volume_ strname - The name of the source volume.
- capacity_
tier str - The volume's capacity tier for tiering cold data to object storage: ['S3', 'Blob', 'cloudStorage']. The default values for each cloud provider are as follows: Amazon => 'S3', Azure => 'Blob', GCP => 'cloudStorage'. If none, the capacity tier won't be set on volume creation.
- connector_
ip str - The private IP of the connector, this is only required for Restricted mode account.
- deployment_
mode str - The mode of deployment to use for the working environment: ['Standard', 'Restricted']. The default is 'Standard'. To know more on deployment modes https://docs.netapp.com/us-en/bluexp-setup-admin/concept-modes.html/.
- destination_
aggregate_ strname - The aggregate in which the volume will be created. If not provided, Cloud Manager chooses the best aggregate for you.
- destination_
svm_ strname - The name of the destination SVM. The default SVM name is used, if a name isn't provided.
- destination_
working_ strenvironment_ id - The public ID of the destination working environment where the snapmirror relationship will be created.
- destination_
working_ strenvironment_ name - The destination working environment name where the snapmirror relationship will be created. It will be ignored if working_environment_id is provided.
- iops float
- max_
transfer_ floatrate - Maximum transfer rate limit (KB/s). Use 0 for no limit, otherwise use number between 1024 and 2,147,482,624. The default is 100000.
- policy str
- The SnapMirror policy name. The default is 'MirrorAllSnapshots'.
- provider_
volume_ strtype - The underlying cloud provider volume type. For AWS: ['gp3', 'gp2', 'io1', 'st1', 'sc1']. For Azure: ['Premium_LRS','Standard_LRS','StandardSSD_LRS']. For GCP: ['pd-balanced', 'pd-ssd','pd-standard']
- schedule str
- Schedule name. The default is '1hour'.
- snapmirror_
id str - will be the snapmirror name.
- source_
svm_ strname - The name of the source SVM. The default SVM name is used, if a name isn't provided.
- source_
working_ strenvironment_ id - The public ID of the source working environment where the snapmirror relationship will be created.
- source_
working_ strenvironment_ name - The source working environment name where the snapmirror relationship will be created. It will be ignored if working_environment_id is provided.
- tenant_
id str - The NetApp tenant ID that the Connector will be associated with. To be used in FSX or when
deployment_mode
isRestricted
. You can find the tenant ID in the Identity & Access Management in Settings, Organization tab of BlueXP at https://console.bluexp.netapp.com/. - throughput float
- client
Id String - The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
- destination
Volume StringName - The name of the destination volume to be created for snapmirror relationship.
- source
Volume StringName - The name of the source volume.
- capacity
Tier String - The volume's capacity tier for tiering cold data to object storage: ['S3', 'Blob', 'cloudStorage']. The default values for each cloud provider are as follows: Amazon => 'S3', Azure => 'Blob', GCP => 'cloudStorage'. If none, the capacity tier won't be set on volume creation.
- connector
Ip String - The private IP of the connector, this is only required for Restricted mode account.
- deployment
Mode String - The mode of deployment to use for the working environment: ['Standard', 'Restricted']. The default is 'Standard'. To know more on deployment modes https://docs.netapp.com/us-en/bluexp-setup-admin/concept-modes.html/.
- destination
Aggregate StringName - The aggregate in which the volume will be created. If not provided, Cloud Manager chooses the best aggregate for you.
- destination
Svm StringName - The name of the destination SVM. The default SVM name is used, if a name isn't provided.
- destination
Working StringEnvironment Id - The public ID of the destination working environment where the snapmirror relationship will be created.
- destination
Working StringEnvironment Name - The destination working environment name where the snapmirror relationship will be created. It will be ignored if working_environment_id is provided.
- iops Number
- max
Transfer NumberRate - Maximum transfer rate limit (KB/s). Use 0 for no limit, otherwise use number between 1024 and 2,147,482,624. The default is 100000.
- policy String
- The SnapMirror policy name. The default is 'MirrorAllSnapshots'.
- provider
Volume StringType - The underlying cloud provider volume type. For AWS: ['gp3', 'gp2', 'io1', 'st1', 'sc1']. For Azure: ['Premium_LRS','Standard_LRS','StandardSSD_LRS']. For GCP: ['pd-balanced', 'pd-ssd','pd-standard']
- schedule String
- Schedule name. The default is '1hour'.
- snapmirror
Id String - will be the snapmirror name.
- source
Svm StringName - The name of the source SVM. The default SVM name is used, if a name isn't provided.
- source
Working StringEnvironment Id - The public ID of the source working environment where the snapmirror relationship will be created.
- source
Working StringEnvironment Name - The source working environment name where the snapmirror relationship will be created. It will be ignored if working_environment_id is provided.
- tenant
Id String - The NetApp tenant ID that the Connector will be associated with. To be used in FSX or when
deployment_mode
isRestricted
. You can find the tenant ID in the Identity & Access Management in Settings, Organization tab of BlueXP at https://console.bluexp.netapp.com/. - throughput Number
Outputs
All input properties are implicitly available as output properties. Additionally, the Snapmirror 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 Snapmirror Resource
Get an existing Snapmirror 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?: SnapmirrorState, opts?: CustomResourceOptions): Snapmirror
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
capacity_tier: Optional[str] = None,
client_id: Optional[str] = None,
connector_ip: Optional[str] = None,
deployment_mode: Optional[str] = None,
destination_aggregate_name: Optional[str] = None,
destination_svm_name: Optional[str] = None,
destination_volume_name: Optional[str] = None,
destination_working_environment_id: Optional[str] = None,
destination_working_environment_name: Optional[str] = None,
iops: Optional[float] = None,
max_transfer_rate: Optional[float] = None,
policy: Optional[str] = None,
provider_volume_type: Optional[str] = None,
schedule: Optional[str] = None,
snapmirror_id: Optional[str] = None,
source_svm_name: Optional[str] = None,
source_volume_name: Optional[str] = None,
source_working_environment_id: Optional[str] = None,
source_working_environment_name: Optional[str] = None,
tenant_id: Optional[str] = None,
throughput: Optional[float] = None) -> Snapmirror
func GetSnapmirror(ctx *Context, name string, id IDInput, state *SnapmirrorState, opts ...ResourceOption) (*Snapmirror, error)
public static Snapmirror Get(string name, Input<string> id, SnapmirrorState? state, CustomResourceOptions? opts = null)
public static Snapmirror get(String name, Output<String> id, SnapmirrorState state, CustomResourceOptions options)
resources: _: type: netapp-cloudmanager:Snapmirror 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.
- Capacity
Tier string - The volume's capacity tier for tiering cold data to object storage: ['S3', 'Blob', 'cloudStorage']. The default values for each cloud provider are as follows: Amazon => 'S3', Azure => 'Blob', GCP => 'cloudStorage'. If none, the capacity tier won't be set on volume creation.
- Client
Id string - The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
- Connector
Ip string - The private IP of the connector, this is only required for Restricted mode account.
- Deployment
Mode string - The mode of deployment to use for the working environment: ['Standard', 'Restricted']. The default is 'Standard'. To know more on deployment modes https://docs.netapp.com/us-en/bluexp-setup-admin/concept-modes.html/.
- Destination
Aggregate stringName - The aggregate in which the volume will be created. If not provided, Cloud Manager chooses the best aggregate for you.
- Destination
Svm stringName - The name of the destination SVM. The default SVM name is used, if a name isn't provided.
- Destination
Volume stringName - The name of the destination volume to be created for snapmirror relationship.
- Destination
Working stringEnvironment Id - The public ID of the destination working environment where the snapmirror relationship will be created.
- Destination
Working stringEnvironment Name - The destination working environment name where the snapmirror relationship will be created. It will be ignored if working_environment_id is provided.
- Iops double
- Max
Transfer doubleRate - Maximum transfer rate limit (KB/s). Use 0 for no limit, otherwise use number between 1024 and 2,147,482,624. The default is 100000.
- Policy string
- The SnapMirror policy name. The default is 'MirrorAllSnapshots'.
- Provider
Volume stringType - The underlying cloud provider volume type. For AWS: ['gp3', 'gp2', 'io1', 'st1', 'sc1']. For Azure: ['Premium_LRS','Standard_LRS','StandardSSD_LRS']. For GCP: ['pd-balanced', 'pd-ssd','pd-standard']
- Schedule string
- Schedule name. The default is '1hour'.
- Snapmirror
Id string - will be the snapmirror name.
- Source
Svm stringName - The name of the source SVM. The default SVM name is used, if a name isn't provided.
- Source
Volume stringName - The name of the source volume.
- Source
Working stringEnvironment Id - The public ID of the source working environment where the snapmirror relationship will be created.
- Source
Working stringEnvironment Name - The source working environment name where the snapmirror relationship will be created. It will be ignored if working_environment_id is provided.
- Tenant
Id string - The NetApp tenant ID that the Connector will be associated with. To be used in FSX or when
deployment_mode
isRestricted
. You can find the tenant ID in the Identity & Access Management in Settings, Organization tab of BlueXP at https://console.bluexp.netapp.com/. - Throughput double
- Capacity
Tier string - The volume's capacity tier for tiering cold data to object storage: ['S3', 'Blob', 'cloudStorage']. The default values for each cloud provider are as follows: Amazon => 'S3', Azure => 'Blob', GCP => 'cloudStorage'. If none, the capacity tier won't be set on volume creation.
- Client
Id string - The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
- Connector
Ip string - The private IP of the connector, this is only required for Restricted mode account.
- Deployment
Mode string - The mode of deployment to use for the working environment: ['Standard', 'Restricted']. The default is 'Standard'. To know more on deployment modes https://docs.netapp.com/us-en/bluexp-setup-admin/concept-modes.html/.
- Destination
Aggregate stringName - The aggregate in which the volume will be created. If not provided, Cloud Manager chooses the best aggregate for you.
- Destination
Svm stringName - The name of the destination SVM. The default SVM name is used, if a name isn't provided.
- Destination
Volume stringName - The name of the destination volume to be created for snapmirror relationship.
- Destination
Working stringEnvironment Id - The public ID of the destination working environment where the snapmirror relationship will be created.
- Destination
Working stringEnvironment Name - The destination working environment name where the snapmirror relationship will be created. It will be ignored if working_environment_id is provided.
- Iops float64
- Max
Transfer float64Rate - Maximum transfer rate limit (KB/s). Use 0 for no limit, otherwise use number between 1024 and 2,147,482,624. The default is 100000.
- Policy string
- The SnapMirror policy name. The default is 'MirrorAllSnapshots'.
- Provider
Volume stringType - The underlying cloud provider volume type. For AWS: ['gp3', 'gp2', 'io1', 'st1', 'sc1']. For Azure: ['Premium_LRS','Standard_LRS','StandardSSD_LRS']. For GCP: ['pd-balanced', 'pd-ssd','pd-standard']
- Schedule string
- Schedule name. The default is '1hour'.
- Snapmirror
Id string - will be the snapmirror name.
- Source
Svm stringName - The name of the source SVM. The default SVM name is used, if a name isn't provided.
- Source
Volume stringName - The name of the source volume.
- Source
Working stringEnvironment Id - The public ID of the source working environment where the snapmirror relationship will be created.
- Source
Working stringEnvironment Name - The source working environment name where the snapmirror relationship will be created. It will be ignored if working_environment_id is provided.
- Tenant
Id string - The NetApp tenant ID that the Connector will be associated with. To be used in FSX or when
deployment_mode
isRestricted
. You can find the tenant ID in the Identity & Access Management in Settings, Organization tab of BlueXP at https://console.bluexp.netapp.com/. - Throughput float64
- capacity
Tier String - The volume's capacity tier for tiering cold data to object storage: ['S3', 'Blob', 'cloudStorage']. The default values for each cloud provider are as follows: Amazon => 'S3', Azure => 'Blob', GCP => 'cloudStorage'. If none, the capacity tier won't be set on volume creation.
- client
Id String - The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
- connector
Ip String - The private IP of the connector, this is only required for Restricted mode account.
- deployment
Mode String - The mode of deployment to use for the working environment: ['Standard', 'Restricted']. The default is 'Standard'. To know more on deployment modes https://docs.netapp.com/us-en/bluexp-setup-admin/concept-modes.html/.
- destination
Aggregate StringName - The aggregate in which the volume will be created. If not provided, Cloud Manager chooses the best aggregate for you.
- destination
Svm StringName - The name of the destination SVM. The default SVM name is used, if a name isn't provided.
- destination
Volume StringName - The name of the destination volume to be created for snapmirror relationship.
- destination
Working StringEnvironment Id - The public ID of the destination working environment where the snapmirror relationship will be created.
- destination
Working StringEnvironment Name - The destination working environment name where the snapmirror relationship will be created. It will be ignored if working_environment_id is provided.
- iops Double
- max
Transfer DoubleRate - Maximum transfer rate limit (KB/s). Use 0 for no limit, otherwise use number between 1024 and 2,147,482,624. The default is 100000.
- policy String
- The SnapMirror policy name. The default is 'MirrorAllSnapshots'.
- provider
Volume StringType - The underlying cloud provider volume type. For AWS: ['gp3', 'gp2', 'io1', 'st1', 'sc1']. For Azure: ['Premium_LRS','Standard_LRS','StandardSSD_LRS']. For GCP: ['pd-balanced', 'pd-ssd','pd-standard']
- schedule String
- Schedule name. The default is '1hour'.
- snapmirror
Id String - will be the snapmirror name.
- source
Svm StringName - The name of the source SVM. The default SVM name is used, if a name isn't provided.
- source
Volume StringName - The name of the source volume.
- source
Working StringEnvironment Id - The public ID of the source working environment where the snapmirror relationship will be created.
- source
Working StringEnvironment Name - The source working environment name where the snapmirror relationship will be created. It will be ignored if working_environment_id is provided.
- tenant
Id String - The NetApp tenant ID that the Connector will be associated with. To be used in FSX or when
deployment_mode
isRestricted
. You can find the tenant ID in the Identity & Access Management in Settings, Organization tab of BlueXP at https://console.bluexp.netapp.com/. - throughput Double
- capacity
Tier string - The volume's capacity tier for tiering cold data to object storage: ['S3', 'Blob', 'cloudStorage']. The default values for each cloud provider are as follows: Amazon => 'S3', Azure => 'Blob', GCP => 'cloudStorage'. If none, the capacity tier won't be set on volume creation.
- client
Id string - The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
- connector
Ip string - The private IP of the connector, this is only required for Restricted mode account.
- deployment
Mode string - The mode of deployment to use for the working environment: ['Standard', 'Restricted']. The default is 'Standard'. To know more on deployment modes https://docs.netapp.com/us-en/bluexp-setup-admin/concept-modes.html/.
- destination
Aggregate stringName - The aggregate in which the volume will be created. If not provided, Cloud Manager chooses the best aggregate for you.
- destination
Svm stringName - The name of the destination SVM. The default SVM name is used, if a name isn't provided.
- destination
Volume stringName - The name of the destination volume to be created for snapmirror relationship.
- destination
Working stringEnvironment Id - The public ID of the destination working environment where the snapmirror relationship will be created.
- destination
Working stringEnvironment Name - The destination working environment name where the snapmirror relationship will be created. It will be ignored if working_environment_id is provided.
- iops number
- max
Transfer numberRate - Maximum transfer rate limit (KB/s). Use 0 for no limit, otherwise use number between 1024 and 2,147,482,624. The default is 100000.
- policy string
- The SnapMirror policy name. The default is 'MirrorAllSnapshots'.
- provider
Volume stringType - The underlying cloud provider volume type. For AWS: ['gp3', 'gp2', 'io1', 'st1', 'sc1']. For Azure: ['Premium_LRS','Standard_LRS','StandardSSD_LRS']. For GCP: ['pd-balanced', 'pd-ssd','pd-standard']
- schedule string
- Schedule name. The default is '1hour'.
- snapmirror
Id string - will be the snapmirror name.
- source
Svm stringName - The name of the source SVM. The default SVM name is used, if a name isn't provided.
- source
Volume stringName - The name of the source volume.
- source
Working stringEnvironment Id - The public ID of the source working environment where the snapmirror relationship will be created.
- source
Working stringEnvironment Name - The source working environment name where the snapmirror relationship will be created. It will be ignored if working_environment_id is provided.
- tenant
Id string - The NetApp tenant ID that the Connector will be associated with. To be used in FSX or when
deployment_mode
isRestricted
. You can find the tenant ID in the Identity & Access Management in Settings, Organization tab of BlueXP at https://console.bluexp.netapp.com/. - throughput number
- capacity_
tier str - The volume's capacity tier for tiering cold data to object storage: ['S3', 'Blob', 'cloudStorage']. The default values for each cloud provider are as follows: Amazon => 'S3', Azure => 'Blob', GCP => 'cloudStorage'. If none, the capacity tier won't be set on volume creation.
- client_
id str - The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
- connector_
ip str - The private IP of the connector, this is only required for Restricted mode account.
- deployment_
mode str - The mode of deployment to use for the working environment: ['Standard', 'Restricted']. The default is 'Standard'. To know more on deployment modes https://docs.netapp.com/us-en/bluexp-setup-admin/concept-modes.html/.
- destination_
aggregate_ strname - The aggregate in which the volume will be created. If not provided, Cloud Manager chooses the best aggregate for you.
- destination_
svm_ strname - The name of the destination SVM. The default SVM name is used, if a name isn't provided.
- destination_
volume_ strname - The name of the destination volume to be created for snapmirror relationship.
- destination_
working_ strenvironment_ id - The public ID of the destination working environment where the snapmirror relationship will be created.
- destination_
working_ strenvironment_ name - The destination working environment name where the snapmirror relationship will be created. It will be ignored if working_environment_id is provided.
- iops float
- max_
transfer_ floatrate - Maximum transfer rate limit (KB/s). Use 0 for no limit, otherwise use number between 1024 and 2,147,482,624. The default is 100000.
- policy str
- The SnapMirror policy name. The default is 'MirrorAllSnapshots'.
- provider_
volume_ strtype - The underlying cloud provider volume type. For AWS: ['gp3', 'gp2', 'io1', 'st1', 'sc1']. For Azure: ['Premium_LRS','Standard_LRS','StandardSSD_LRS']. For GCP: ['pd-balanced', 'pd-ssd','pd-standard']
- schedule str
- Schedule name. The default is '1hour'.
- snapmirror_
id str - will be the snapmirror name.
- source_
svm_ strname - The name of the source SVM. The default SVM name is used, if a name isn't provided.
- source_
volume_ strname - The name of the source volume.
- source_
working_ strenvironment_ id - The public ID of the source working environment where the snapmirror relationship will be created.
- source_
working_ strenvironment_ name - The source working environment name where the snapmirror relationship will be created. It will be ignored if working_environment_id is provided.
- tenant_
id str - The NetApp tenant ID that the Connector will be associated with. To be used in FSX or when
deployment_mode
isRestricted
. You can find the tenant ID in the Identity & Access Management in Settings, Organization tab of BlueXP at https://console.bluexp.netapp.com/. - throughput float
- capacity
Tier String - The volume's capacity tier for tiering cold data to object storage: ['S3', 'Blob', 'cloudStorage']. The default values for each cloud provider are as follows: Amazon => 'S3', Azure => 'Blob', GCP => 'cloudStorage'. If none, the capacity tier won't be set on volume creation.
- client
Id String - The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
- connector
Ip String - The private IP of the connector, this is only required for Restricted mode account.
- deployment
Mode String - The mode of deployment to use for the working environment: ['Standard', 'Restricted']. The default is 'Standard'. To know more on deployment modes https://docs.netapp.com/us-en/bluexp-setup-admin/concept-modes.html/.
- destination
Aggregate StringName - The aggregate in which the volume will be created. If not provided, Cloud Manager chooses the best aggregate for you.
- destination
Svm StringName - The name of the destination SVM. The default SVM name is used, if a name isn't provided.
- destination
Volume StringName - The name of the destination volume to be created for snapmirror relationship.
- destination
Working StringEnvironment Id - The public ID of the destination working environment where the snapmirror relationship will be created.
- destination
Working StringEnvironment Name - The destination working environment name where the snapmirror relationship will be created. It will be ignored if working_environment_id is provided.
- iops Number
- max
Transfer NumberRate - Maximum transfer rate limit (KB/s). Use 0 for no limit, otherwise use number between 1024 and 2,147,482,624. The default is 100000.
- policy String
- The SnapMirror policy name. The default is 'MirrorAllSnapshots'.
- provider
Volume StringType - The underlying cloud provider volume type. For AWS: ['gp3', 'gp2', 'io1', 'st1', 'sc1']. For Azure: ['Premium_LRS','Standard_LRS','StandardSSD_LRS']. For GCP: ['pd-balanced', 'pd-ssd','pd-standard']
- schedule String
- Schedule name. The default is '1hour'.
- snapmirror
Id String - will be the snapmirror name.
- source
Svm StringName - The name of the source SVM. The default SVM name is used, if a name isn't provided.
- source
Volume StringName - The name of the source volume.
- source
Working StringEnvironment Id - The public ID of the source working environment where the snapmirror relationship will be created.
- source
Working StringEnvironment Name - The source working environment name where the snapmirror relationship will be created. It will be ignored if working_environment_id is provided.
- tenant
Id String - The NetApp tenant ID that the Connector will be associated with. To be used in FSX or when
deployment_mode
isRestricted
. You can find the tenant ID in the Identity & Access Management in Settings, Organization tab of BlueXP at https://console.bluexp.netapp.com/. - throughput Number
Package Details
- Repository
- netapp-cloudmanager netapp/terraform-provider-netapp-cloudmanager
- License
- Notes
- This Pulumi package is based on the
netapp-cloudmanager
Terraform Provider.