Volume

netapp-cloudmanager 27.1.0, Mar 20 26

Viewing docs for netapp-cloudmanager 27.1.0
published on Friday, Mar 20, 2026 by netapp

Schema (JSON)

netapp/terraform-provider-netapp-cloudmanager

Viewing docs for netapp-cloudmanager 27.1.0
published on Friday, Mar 20, 2026 by netapp

Schema (JSON)

netapp/terraform-provider-netapp-cloudmanager

Create Volume Resource

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

Constructor syntax

new Volume(name: string, args: VolumeArgs, opts?: CustomResourceOptions);

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

@overload
def Volume(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           provider_volume_type: Optional[str] = None,
           unit: Optional[str] = None,
           size: Optional[float] = None,
           client_id: Optional[str] = None,
           iops: Optional[float] = None,
           permission: Optional[str] = None,
           deployment_mode: Optional[str] = None,
           enable_compression: Optional[bool] = None,
           enable_deduplication: Optional[bool] = None,
           enable_thin_provisioning: Optional[bool] = None,
           export_policy_ips: Optional[Sequence[str]] = None,
           export_policy_name: Optional[str] = None,
           export_policy_nfs_versions: Optional[Sequence[str]] = None,
           export_policy_rule_access_control: Optional[str] = None,
           export_policy_rule_super_user: Optional[bool] = None,
           export_policy_type: Optional[str] = None,
           igroups: Optional[Sequence[str]] = None,
           initiators: Optional[Sequence[VolumeInitiatorArgs]] = None,
           aggregate_name: Optional[str] = None,
           name: Optional[str] = None,
           os_name: Optional[str] = None,
           connector_ip: Optional[str] = None,
           comment: Optional[str] = None,
           share_name: Optional[str] = None,
           capacity_tier: Optional[str] = None,
           snapshot_policies: Optional[Sequence[VolumeSnapshotPolicyArgs]] = None,
           snapshot_policy_name: Optional[str] = None,
           svm_name: Optional[str] = None,
           sync_avs_hosts: Optional[VolumeSyncAvsHostsArgs] = None,
           tags: Optional[Mapping[str, str]] = None,
           tenant_id: Optional[str] = None,
           throughput: Optional[float] = None,
           tiering_policy: Optional[str] = None,
           avs_integration: Optional[VolumeAvsIntegrationArgs] = None,
           users: Optional[Sequence[str]] = None,
           volume_id: Optional[str] = None,
           volume_protocol: Optional[str] = None,
           working_environment_id: Optional[str] = None,
           working_environment_name: Optional[str] = None)

func NewVolume(ctx *Context, name string, args VolumeArgs, opts ...ResourceOption) (*Volume, error)

public Volume(string name, VolumeArgs args, CustomResourceOptions? opts = null)

public Volume(String name, VolumeArgs args)
public Volume(String name, VolumeArgs args, CustomResourceOptions options)

type: netapp-cloudmanager:Volume
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 VolumeArgs: 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 VolumeArgs: 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 VolumeArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

name String: The unique name of the resource.
args VolumeArgs: 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 volumeResource = new NetappCloudmanager.Volume("volumeResource", new()
{
    ProviderVolumeType = "string",
    Unit = "string",
    Size = 0,
    ClientId = "string",
    Iops = 0,
    Permission = "string",
    DeploymentMode = "string",
    EnableCompression = false,
    EnableDeduplication = false,
    EnableThinProvisioning = false,
    ExportPolicyIps = new[]
    {
        "string",
    },
    ExportPolicyName = "string",
    ExportPolicyNfsVersions = new[]
    {
        "string",
    },
    ExportPolicyRuleAccessControl = "string",
    ExportPolicyRuleSuperUser = false,
    ExportPolicyType = "string",
    Igroups = new[]
    {
        "string",
    },
    Initiators = new[]
    {
        new NetappCloudmanager.Inputs.VolumeInitiatorArgs
        {
            Alias = "string",
            Iqn = "string",
        },
    },
    AggregateName = "string",
    Name = "string",
    OsName = "string",
    ConnectorIp = "string",
    Comment = "string",
    ShareName = "string",
    CapacityTier = "string",
    SnapshotPolicies = new[]
    {
        new NetappCloudmanager.Inputs.VolumeSnapshotPolicyArgs
        {
            Schedules = new[]
            {
                new NetappCloudmanager.Inputs.VolumeSnapshotPolicyScheduleArgs
                {
                    Retention = 0,
                    ScheduleType = "string",
                },
            },
        },
    },
    SnapshotPolicyName = "string",
    SvmName = "string",
    SyncAvsHosts = new NetappCloudmanager.Inputs.VolumeSyncAvsHostsArgs
    {
        ClusterName = "string",
        PrivateCloudName = "string",
        ResourceGroup = "string",
        SyncTrigger = "string",
    },
    Tags = 
    {
        { "string", "string" },
    },
    TenantId = "string",
    Throughput = 0,
    TieringPolicy = "string",
    AvsIntegration = new NetappCloudmanager.Inputs.VolumeAvsIntegrationArgs
    {
        ClusterName = "string",
        DatastoreName = "string",
        DatastoreSizeCapacity = 0,
        DatastoreSizeUnit = "string",
        PrivateCloudName = "string",
        ResourceGroup = "string",
    },
    Users = new[]
    {
        "string",
    },
    VolumeId = "string",
    VolumeProtocol = "string",
    WorkingEnvironmentId = "string",
    WorkingEnvironmentName = "string",
});

example, err := netappcloudmanager.NewVolume(ctx, "volumeResource", &netappcloudmanager.VolumeArgs{
	ProviderVolumeType:     pulumi.String("string"),
	Unit:                   pulumi.String("string"),
	Size:                   pulumi.Float64(0),
	ClientId:               pulumi.String("string"),
	Iops:                   pulumi.Float64(0),
	Permission:             pulumi.String("string"),
	DeploymentMode:         pulumi.String("string"),
	EnableCompression:      pulumi.Bool(false),
	EnableDeduplication:    pulumi.Bool(false),
	EnableThinProvisioning: pulumi.Bool(false),
	ExportPolicyIps: pulumi.StringArray{
		pulumi.String("string"),
	},
	ExportPolicyName: pulumi.String("string"),
	ExportPolicyNfsVersions: pulumi.StringArray{
		pulumi.String("string"),
	},
	ExportPolicyRuleAccessControl: pulumi.String("string"),
	ExportPolicyRuleSuperUser:     pulumi.Bool(false),
	ExportPolicyType:              pulumi.String("string"),
	Igroups: pulumi.StringArray{
		pulumi.String("string"),
	},
	Initiators: netappcloudmanager.VolumeInitiatorArray{
		&netappcloudmanager.VolumeInitiatorArgs{
			Alias: pulumi.String("string"),
			Iqn:   pulumi.String("string"),
		},
	},
	AggregateName: pulumi.String("string"),
	Name:          pulumi.String("string"),
	OsName:        pulumi.String("string"),
	ConnectorIp:   pulumi.String("string"),
	Comment:       pulumi.String("string"),
	ShareName:     pulumi.String("string"),
	CapacityTier:  pulumi.String("string"),
	SnapshotPolicies: netappcloudmanager.VolumeSnapshotPolicyArray{
		&netappcloudmanager.VolumeSnapshotPolicyArgs{
			Schedules: netappcloudmanager.VolumeSnapshotPolicyScheduleArray{
				&netappcloudmanager.VolumeSnapshotPolicyScheduleArgs{
					Retention:    pulumi.Float64(0),
					ScheduleType: pulumi.String("string"),
				},
			},
		},
	},
	SnapshotPolicyName: pulumi.String("string"),
	SvmName:            pulumi.String("string"),
	SyncAvsHosts: &netappcloudmanager.VolumeSyncAvsHostsArgs{
		ClusterName:      pulumi.String("string"),
		PrivateCloudName: pulumi.String("string"),
		ResourceGroup:    pulumi.String("string"),
		SyncTrigger:      pulumi.String("string"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	TenantId:      pulumi.String("string"),
	Throughput:    pulumi.Float64(0),
	TieringPolicy: pulumi.String("string"),
	AvsIntegration: &netappcloudmanager.VolumeAvsIntegrationArgs{
		ClusterName:           pulumi.String("string"),
		DatastoreName:         pulumi.String("string"),
		DatastoreSizeCapacity: pulumi.Float64(0),
		DatastoreSizeUnit:     pulumi.String("string"),
		PrivateCloudName:      pulumi.String("string"),
		ResourceGroup:         pulumi.String("string"),
	},
	Users: pulumi.StringArray{
		pulumi.String("string"),
	},
	VolumeId:               pulumi.String("string"),
	VolumeProtocol:         pulumi.String("string"),
	WorkingEnvironmentId:   pulumi.String("string"),
	WorkingEnvironmentName: pulumi.String("string"),
})

var volumeResource = new Volume("volumeResource", VolumeArgs.builder()
    .providerVolumeType("string")
    .unit("string")
    .size(0.0)
    .clientId("string")
    .iops(0.0)
    .permission("string")
    .deploymentMode("string")
    .enableCompression(false)
    .enableDeduplication(false)
    .enableThinProvisioning(false)
    .exportPolicyIps("string")
    .exportPolicyName("string")
    .exportPolicyNfsVersions("string")
    .exportPolicyRuleAccessControl("string")
    .exportPolicyRuleSuperUser(false)
    .exportPolicyType("string")
    .igroups("string")
    .initiators(VolumeInitiatorArgs.builder()
        .alias("string")
        .iqn("string")
        .build())
    .aggregateName("string")
    .name("string")
    .osName("string")
    .connectorIp("string")
    .comment("string")
    .shareName("string")
    .capacityTier("string")
    .snapshotPolicies(VolumeSnapshotPolicyArgs.builder()
        .schedules(VolumeSnapshotPolicyScheduleArgs.builder()
            .retention(0.0)
            .scheduleType("string")
            .build())
        .build())
    .snapshotPolicyName("string")
    .svmName("string")
    .syncAvsHosts(VolumeSyncAvsHostsArgs.builder()
        .clusterName("string")
        .privateCloudName("string")
        .resourceGroup("string")
        .syncTrigger("string")
        .build())
    .tags(Map.of("string", "string"))
    .tenantId("string")
    .throughput(0.0)
    .tieringPolicy("string")
    .avsIntegration(VolumeAvsIntegrationArgs.builder()
        .clusterName("string")
        .datastoreName("string")
        .datastoreSizeCapacity(0.0)
        .datastoreSizeUnit("string")
        .privateCloudName("string")
        .resourceGroup("string")
        .build())
    .users("string")
    .volumeId("string")
    .volumeProtocol("string")
    .workingEnvironmentId("string")
    .workingEnvironmentName("string")
    .build());

volume_resource = netapp_cloudmanager.Volume("volumeResource",
    provider_volume_type="string",
    unit="string",
    size=0,
    client_id="string",
    iops=0,
    permission="string",
    deployment_mode="string",
    enable_compression=False,
    enable_deduplication=False,
    enable_thin_provisioning=False,
    export_policy_ips=["string"],
    export_policy_name="string",
    export_policy_nfs_versions=["string"],
    export_policy_rule_access_control="string",
    export_policy_rule_super_user=False,
    export_policy_type="string",
    igroups=["string"],
    initiators=[{
        "alias": "string",
        "iqn": "string",
    }],
    aggregate_name="string",
    name="string",
    os_name="string",
    connector_ip="string",
    comment="string",
    share_name="string",
    capacity_tier="string",
    snapshot_policies=[{
        "schedules": [{
            "retention": 0,
            "schedule_type": "string",
        }],
    }],
    snapshot_policy_name="string",
    svm_name="string",
    sync_avs_hosts={
        "cluster_name": "string",
        "private_cloud_name": "string",
        "resource_group": "string",
        "sync_trigger": "string",
    },
    tags={
        "string": "string",
    },
    tenant_id="string",
    throughput=0,
    tiering_policy="string",
    avs_integration={
        "cluster_name": "string",
        "datastore_name": "string",
        "datastore_size_capacity": 0,
        "datastore_size_unit": "string",
        "private_cloud_name": "string",
        "resource_group": "string",
    },
    users=["string"],
    volume_id="string",
    volume_protocol="string",
    working_environment_id="string",
    working_environment_name="string")

const volumeResource = new netapp_cloudmanager.Volume("volumeResource", {
    providerVolumeType: "string",
    unit: "string",
    size: 0,
    clientId: "string",
    iops: 0,
    permission: "string",
    deploymentMode: "string",
    enableCompression: false,
    enableDeduplication: false,
    enableThinProvisioning: false,
    exportPolicyIps: ["string"],
    exportPolicyName: "string",
    exportPolicyNfsVersions: ["string"],
    exportPolicyRuleAccessControl: "string",
    exportPolicyRuleSuperUser: false,
    exportPolicyType: "string",
    igroups: ["string"],
    initiators: [{
        alias: "string",
        iqn: "string",
    }],
    aggregateName: "string",
    name: "string",
    osName: "string",
    connectorIp: "string",
    comment: "string",
    shareName: "string",
    capacityTier: "string",
    snapshotPolicies: [{
        schedules: [{
            retention: 0,
            scheduleType: "string",
        }],
    }],
    snapshotPolicyName: "string",
    svmName: "string",
    syncAvsHosts: {
        clusterName: "string",
        privateCloudName: "string",
        resourceGroup: "string",
        syncTrigger: "string",
    },
    tags: {
        string: "string",
    },
    tenantId: "string",
    throughput: 0,
    tieringPolicy: "string",
    avsIntegration: {
        clusterName: "string",
        datastoreName: "string",
        datastoreSizeCapacity: 0,
        datastoreSizeUnit: "string",
        privateCloudName: "string",
        resourceGroup: "string",
    },
    users: ["string"],
    volumeId: "string",
    volumeProtocol: "string",
    workingEnvironmentId: "string",
    workingEnvironmentName: "string",
});

type: netapp-cloudmanager:Volume
properties:
    aggregateName: string
    avsIntegration:
        clusterName: string
        datastoreName: string
        datastoreSizeCapacity: 0
        datastoreSizeUnit: string
        privateCloudName: string
        resourceGroup: string
    capacityTier: string
    clientId: string
    comment: string
    connectorIp: string
    deploymentMode: string
    enableCompression: false
    enableDeduplication: false
    enableThinProvisioning: false
    exportPolicyIps:
        - string
    exportPolicyName: string
    exportPolicyNfsVersions:
        - string
    exportPolicyRuleAccessControl: string
    exportPolicyRuleSuperUser: false
    exportPolicyType: string
    igroups:
        - string
    initiators:
        - alias: string
          iqn: string
    iops: 0
    name: string
    osName: string
    permission: string
    providerVolumeType: string
    shareName: string
    size: 0
    snapshotPolicies:
        - schedules:
            - retention: 0
              scheduleType: string
    snapshotPolicyName: string
    svmName: string
    syncAvsHosts:
        clusterName: string
        privateCloudName: string
        resourceGroup: string
        syncTrigger: string
    tags:
        string: string
    tenantId: string
    throughput: 0
    tieringPolicy: string
    unit: string
    users:
        - string
    volumeId: string
    volumeProtocol: string
    workingEnvironmentId: string
    workingEnvironmentName: string

Volume 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 Volume resource accepts the following input properties:

ClientId string
ProviderVolumeType string
Size double
Unit string
AggregateName string
AvsIntegration Pulumi.NetappCloudmanager.Inputs.VolumeAvsIntegration
CapacityTier string
Comment string
ConnectorIp string
DeploymentMode string
EnableCompression bool
EnableDeduplication bool
EnableThinProvisioning bool
ExportPolicyIps List<string>
ExportPolicyName string
ExportPolicyNfsVersions List<string>
ExportPolicyRuleAccessControl string
ExportPolicyRuleSuperUser bool
ExportPolicyType string
Igroups List<string>
Initiators List<Pulumi.NetappCloudmanager.Inputs.VolumeInitiator>
Iops double
Name string
OsName string
Permission string
ShareName string
SnapshotPolicies List<Pulumi.NetappCloudmanager.Inputs.VolumeSnapshotPolicy>
SnapshotPolicyName string
SvmName string
SyncAvsHosts Pulumi.NetappCloudmanager.Inputs.VolumeSyncAvsHosts
Tags Dictionary<string, string>
TenantId string
Throughput double
TieringPolicy string
Users List<string>
VolumeId string
VolumeProtocol string
WorkingEnvironmentId string
WorkingEnvironmentName string

ClientId string
ProviderVolumeType string
Size float64
Unit string
AggregateName string
AvsIntegration VolumeAvsIntegrationArgs
CapacityTier string
Comment string
ConnectorIp string
DeploymentMode string
EnableCompression bool
EnableDeduplication bool
EnableThinProvisioning bool
ExportPolicyIps []string
ExportPolicyName string
ExportPolicyNfsVersions []string
ExportPolicyRuleAccessControl string
ExportPolicyRuleSuperUser bool
ExportPolicyType string
Igroups []string
Initiators []VolumeInitiatorArgs
Iops float64
Name string
OsName string
Permission string
ShareName string
SnapshotPolicies []VolumeSnapshotPolicyArgs
SnapshotPolicyName string
SvmName string
SyncAvsHosts VolumeSyncAvsHostsArgs
Tags map[string]string
TenantId string
Throughput float64
TieringPolicy string
Users []string
VolumeId string
VolumeProtocol string
WorkingEnvironmentId string
WorkingEnvironmentName string

clientId String
providerVolumeType String
size Double
unit String
aggregateName String
avsIntegration VolumeAvsIntegration
capacityTier String
comment String
connectorIp String
deploymentMode String
enableCompression Boolean
enableDeduplication Boolean
enableThinProvisioning Boolean
exportPolicyIps List<String>
exportPolicyName String
exportPolicyNfsVersions List<String>
exportPolicyRuleAccessControl String
exportPolicyRuleSuperUser Boolean
exportPolicyType String
igroups List<String>
initiators List<VolumeInitiator>
iops Double
name String
osName String
permission String
shareName String
snapshotPolicies List<VolumeSnapshotPolicy>
snapshotPolicyName String
svmName String
syncAvsHosts VolumeSyncAvsHosts
tags Map<String,String>
tenantId String
throughput Double
tieringPolicy String
users List<String>
volumeId String
volumeProtocol String
workingEnvironmentId String
workingEnvironmentName String

clientId string
providerVolumeType string
size number
unit string
aggregateName string
avsIntegration VolumeAvsIntegration
capacityTier string
comment string
connectorIp string
deploymentMode string
enableCompression boolean
enableDeduplication boolean
enableThinProvisioning boolean
exportPolicyIps string[]
exportPolicyName string
exportPolicyNfsVersions string[]
exportPolicyRuleAccessControl string
exportPolicyRuleSuperUser boolean
exportPolicyType string
igroups string[]
initiators VolumeInitiator[]
iops number
name string
osName string
permission string
shareName string
snapshotPolicies VolumeSnapshotPolicy[]
snapshotPolicyName string
svmName string
syncAvsHosts VolumeSyncAvsHosts
tags {[key: string]: string}
tenantId string
throughput number
tieringPolicy string
users string[]
volumeId string
volumeProtocol string
workingEnvironmentId string
workingEnvironmentName string

client_id str
provider_volume_type str
size float
unit str
aggregate_name str
avs_integration VolumeAvsIntegrationArgs
capacity_tier str
comment str
connector_ip str
deployment_mode str
enable_compression bool
enable_deduplication bool
enable_thin_provisioning bool
export_policy_ips Sequence[str]
export_policy_name str
export_policy_nfs_versions Sequence[str]
export_policy_rule_access_control str
export_policy_rule_super_user bool
export_policy_type str
igroups Sequence[str]
initiators Sequence[VolumeInitiatorArgs]
iops float
name str
os_name str
permission str
share_name str
snapshot_policies Sequence[VolumeSnapshotPolicyArgs]
snapshot_policy_name str
svm_name str
sync_avs_hosts VolumeSyncAvsHostsArgs
tags Mapping[str, str]
tenant_id str
throughput float
tiering_policy str
users Sequence[str]
volume_id str
volume_protocol str
working_environment_id str
working_environment_name str

clientId String
providerVolumeType String
size Number
unit String
aggregateName String
avsIntegration Property Map
capacityTier String
comment String
connectorIp String
deploymentMode String
enableCompression Boolean
enableDeduplication Boolean
enableThinProvisioning Boolean
exportPolicyIps List<String>
exportPolicyName String
exportPolicyNfsVersions List<String>
exportPolicyRuleAccessControl String
exportPolicyRuleSuperUser Boolean
exportPolicyType String
igroups List<String>
initiators List<Property Map>
iops Number
name String
osName String
permission String
shareName String
snapshotPolicies List<Property Map>
snapshotPolicyName String
svmName String
syncAvsHosts Property Map
tags Map<String>
tenantId String
throughput Number
tieringPolicy String
users List<String>
volumeId String
volumeProtocol String
workingEnvironmentId String
workingEnvironmentName String

Outputs

All input properties are implicitly available as output properties. Additionally, the Volume 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 Volume Resource

Get an existing Volume 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?: VolumeState, opts?: CustomResourceOptions): Volume

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aggregate_name: Optional[str] = None,
        avs_integration: Optional[VolumeAvsIntegrationArgs] = None,
        capacity_tier: Optional[str] = None,
        client_id: Optional[str] = None,
        comment: Optional[str] = None,
        connector_ip: Optional[str] = None,
        deployment_mode: Optional[str] = None,
        enable_compression: Optional[bool] = None,
        enable_deduplication: Optional[bool] = None,
        enable_thin_provisioning: Optional[bool] = None,
        export_policy_ips: Optional[Sequence[str]] = None,
        export_policy_name: Optional[str] = None,
        export_policy_nfs_versions: Optional[Sequence[str]] = None,
        export_policy_rule_access_control: Optional[str] = None,
        export_policy_rule_super_user: Optional[bool] = None,
        export_policy_type: Optional[str] = None,
        igroups: Optional[Sequence[str]] = None,
        initiators: Optional[Sequence[VolumeInitiatorArgs]] = None,
        iops: Optional[float] = None,
        name: Optional[str] = None,
        os_name: Optional[str] = None,
        permission: Optional[str] = None,
        provider_volume_type: Optional[str] = None,
        share_name: Optional[str] = None,
        size: Optional[float] = None,
        snapshot_policies: Optional[Sequence[VolumeSnapshotPolicyArgs]] = None,
        snapshot_policy_name: Optional[str] = None,
        svm_name: Optional[str] = None,
        sync_avs_hosts: Optional[VolumeSyncAvsHostsArgs] = None,
        tags: Optional[Mapping[str, str]] = None,
        tenant_id: Optional[str] = None,
        throughput: Optional[float] = None,
        tiering_policy: Optional[str] = None,
        unit: Optional[str] = None,
        users: Optional[Sequence[str]] = None,
        volume_id: Optional[str] = None,
        volume_protocol: Optional[str] = None,
        working_environment_id: Optional[str] = None,
        working_environment_name: Optional[str] = None) -> Volume

func GetVolume(ctx *Context, name string, id IDInput, state *VolumeState, opts ...ResourceOption) (*Volume, error)

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

public static Volume get(String name, Output<String> id, VolumeState state, CustomResourceOptions options)

resources:  _:    type: netapp-cloudmanager:Volume    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:

AggregateName string
AvsIntegration Pulumi.NetappCloudmanager.Inputs.VolumeAvsIntegration
CapacityTier string
ClientId string
Comment string
ConnectorIp string
DeploymentMode string
EnableCompression bool
EnableDeduplication bool
EnableThinProvisioning bool
ExportPolicyIps List<string>
ExportPolicyName string
ExportPolicyNfsVersions List<string>
ExportPolicyRuleAccessControl string
ExportPolicyRuleSuperUser bool
ExportPolicyType string
Igroups List<string>
Initiators List<Pulumi.NetappCloudmanager.Inputs.VolumeInitiator>
Iops double
Name string
OsName string
Permission string
ProviderVolumeType string
ShareName string
Size double
SnapshotPolicies List<Pulumi.NetappCloudmanager.Inputs.VolumeSnapshotPolicy>
SnapshotPolicyName string
SvmName string
SyncAvsHosts Pulumi.NetappCloudmanager.Inputs.VolumeSyncAvsHosts
Tags Dictionary<string, string>
TenantId string
Throughput double
TieringPolicy string
Unit string
Users List<string>
VolumeId string
VolumeProtocol string
WorkingEnvironmentId string
WorkingEnvironmentName string

AggregateName string
AvsIntegration VolumeAvsIntegrationArgs
CapacityTier string
ClientId string
Comment string
ConnectorIp string
DeploymentMode string
EnableCompression bool
EnableDeduplication bool
EnableThinProvisioning bool
ExportPolicyIps []string
ExportPolicyName string
ExportPolicyNfsVersions []string
ExportPolicyRuleAccessControl string
ExportPolicyRuleSuperUser bool
ExportPolicyType string
Igroups []string
Initiators []VolumeInitiatorArgs
Iops float64
Name string
OsName string
Permission string
ProviderVolumeType string
ShareName string
Size float64
SnapshotPolicies []VolumeSnapshotPolicyArgs
SnapshotPolicyName string
SvmName string
SyncAvsHosts VolumeSyncAvsHostsArgs
Tags map[string]string
TenantId string
Throughput float64
TieringPolicy string
Unit string
Users []string
VolumeId string
VolumeProtocol string
WorkingEnvironmentId string
WorkingEnvironmentName string

aggregateName String
avsIntegration VolumeAvsIntegration
capacityTier String
clientId String
comment String
connectorIp String
deploymentMode String
enableCompression Boolean
enableDeduplication Boolean
enableThinProvisioning Boolean
exportPolicyIps List<String>
exportPolicyName String
exportPolicyNfsVersions List<String>
exportPolicyRuleAccessControl String
exportPolicyRuleSuperUser Boolean
exportPolicyType String
igroups List<String>
initiators List<VolumeInitiator>
iops Double
name String
osName String
permission String
providerVolumeType String
shareName String
size Double
snapshotPolicies List<VolumeSnapshotPolicy>
snapshotPolicyName String
svmName String
syncAvsHosts VolumeSyncAvsHosts
tags Map<String,String>
tenantId String
throughput Double
tieringPolicy String
unit String
users List<String>
volumeId String
volumeProtocol String
workingEnvironmentId String
workingEnvironmentName String

aggregateName string
avsIntegration VolumeAvsIntegration
capacityTier string
clientId string
comment string
connectorIp string
deploymentMode string
enableCompression boolean
enableDeduplication boolean
enableThinProvisioning boolean
exportPolicyIps string[]
exportPolicyName string
exportPolicyNfsVersions string[]
exportPolicyRuleAccessControl string
exportPolicyRuleSuperUser boolean
exportPolicyType string
igroups string[]
initiators VolumeInitiator[]
iops number
name string
osName string
permission string
providerVolumeType string
shareName string
size number
snapshotPolicies VolumeSnapshotPolicy[]
snapshotPolicyName string
svmName string
syncAvsHosts VolumeSyncAvsHosts
tags {[key: string]: string}
tenantId string
throughput number
tieringPolicy string
unit string
users string[]
volumeId string
volumeProtocol string
workingEnvironmentId string
workingEnvironmentName string

aggregate_name str
avs_integration VolumeAvsIntegrationArgs
capacity_tier str
client_id str
comment str
connector_ip str
deployment_mode str
enable_compression bool
enable_deduplication bool
enable_thin_provisioning bool
export_policy_ips Sequence[str]
export_policy_name str
export_policy_nfs_versions Sequence[str]
export_policy_rule_access_control str
export_policy_rule_super_user bool
export_policy_type str
igroups Sequence[str]
initiators Sequence[VolumeInitiatorArgs]
iops float
name str
os_name str
permission str
provider_volume_type str
share_name str
size float
snapshot_policies Sequence[VolumeSnapshotPolicyArgs]
snapshot_policy_name str
svm_name str
sync_avs_hosts VolumeSyncAvsHostsArgs
tags Mapping[str, str]
tenant_id str
throughput float
tiering_policy str
unit str
users Sequence[str]
volume_id str
volume_protocol str
working_environment_id str
working_environment_name str

aggregateName String
avsIntegration Property Map
capacityTier String
clientId String
comment String
connectorIp String
deploymentMode String
enableCompression Boolean
enableDeduplication Boolean
enableThinProvisioning Boolean
exportPolicyIps List<String>
exportPolicyName String
exportPolicyNfsVersions List<String>
exportPolicyRuleAccessControl String
exportPolicyRuleSuperUser Boolean
exportPolicyType String
igroups List<String>
initiators List<Property Map>
iops Number
name String
osName String
permission String
providerVolumeType String
shareName String
size Number
snapshotPolicies List<Property Map>
snapshotPolicyName String
svmName String
syncAvsHosts Property Map
tags Map<String>
tenantId String
throughput Number
tieringPolicy String
unit String
users List<String>
volumeId String
volumeProtocol String
workingEnvironmentId String
workingEnvironmentName String

Supporting Types

VolumeAvsIntegration, VolumeAvsIntegrationArgs

ClusterName string
DatastoreName string
DatastoreSizeCapacity double: The size of the datastore. Must be equal to the LUN size.
DatastoreSizeUnit string: The unit of the datastore size: ['Byte', 'KB', 'MB', 'GB', 'TB'].
PrivateCloudName string
ResourceGroup string

ClusterName string
DatastoreName string
DatastoreSizeCapacity float64: The size of the datastore. Must be equal to the LUN size.
DatastoreSizeUnit string: The unit of the datastore size: ['Byte', 'KB', 'MB', 'GB', 'TB'].
PrivateCloudName string
ResourceGroup string

clusterName String
datastoreName String
datastoreSizeCapacity Double: The size of the datastore. Must be equal to the LUN size.
datastoreSizeUnit String: The unit of the datastore size: ['Byte', 'KB', 'MB', 'GB', 'TB'].
privateCloudName String
resourceGroup String

clusterName string
datastoreName string
datastoreSizeCapacity number: The size of the datastore. Must be equal to the LUN size.
datastoreSizeUnit string: The unit of the datastore size: ['Byte', 'KB', 'MB', 'GB', 'TB'].
privateCloudName string
resourceGroup string

cluster_name str
datastore_name str
datastore_size_capacity float: The size of the datastore. Must be equal to the LUN size.
datastore_size_unit str: The unit of the datastore size: ['Byte', 'KB', 'MB', 'GB', 'TB'].
private_cloud_name str
resource_group str

clusterName String
datastoreName String
datastoreSizeCapacity Number: The size of the datastore. Must be equal to the LUN size.
datastoreSizeUnit String: The unit of the datastore size: ['Byte', 'KB', 'MB', 'GB', 'TB'].
privateCloudName String
resourceGroup String

VolumeInitiator, VolumeInitiatorArgs

Alias string
Iqn string

Alias string
Iqn string

alias String
iqn String

alias string
iqn string

alias str
iqn str

alias String
iqn String

VolumeSnapshotPolicy, VolumeSnapshotPolicyArgs

Schedules List<Pulumi.NetappCloudmanager.Inputs.VolumeSnapshotPolicySchedule>

Schedules []VolumeSnapshotPolicySchedule

schedules List<VolumeSnapshotPolicySchedule>

schedules VolumeSnapshotPolicySchedule[]

schedules Sequence[VolumeSnapshotPolicySchedule]

schedules List<Property Map>

VolumeSnapshotPolicySchedule, VolumeSnapshotPolicyScheduleArgs

Retention double
ScheduleType string

Retention float64
ScheduleType string

retention Double
scheduleType String

retention number
scheduleType string

retention float
schedule_type str

retention Number
scheduleType String

VolumeSyncAvsHosts, VolumeSyncAvsHostsArgs

ClusterName string: The name of the AVS cluster.
PrivateCloudName string: The name of the AVS private cloud.
ResourceGroup string: The resource group of the AVS private cloud.
SyncTrigger string: An arbitrary value that, when changed, forces a re-sync of AVS hosts. Change this value (e.g., increment a number or set a new timestamp) to trigger a re-sync without modifying other fields.

ClusterName string: The name of the AVS cluster.
PrivateCloudName string: The name of the AVS private cloud.
ResourceGroup string: The resource group of the AVS private cloud.
SyncTrigger string: An arbitrary value that, when changed, forces a re-sync of AVS hosts. Change this value (e.g., increment a number or set a new timestamp) to trigger a re-sync without modifying other fields.

clusterName String: The name of the AVS cluster.
privateCloudName String: The name of the AVS private cloud.
resourceGroup String: The resource group of the AVS private cloud.
syncTrigger String: An arbitrary value that, when changed, forces a re-sync of AVS hosts. Change this value (e.g., increment a number or set a new timestamp) to trigger a re-sync without modifying other fields.

clusterName string: The name of the AVS cluster.
privateCloudName string: The name of the AVS private cloud.
resourceGroup string: The resource group of the AVS private cloud.
syncTrigger string: An arbitrary value that, when changed, forces a re-sync of AVS hosts. Change this value (e.g., increment a number or set a new timestamp) to trigger a re-sync without modifying other fields.

cluster_name str: The name of the AVS cluster.
private_cloud_name str: The name of the AVS private cloud.
resource_group str: The resource group of the AVS private cloud.
sync_trigger str: An arbitrary value that, when changed, forces a re-sync of AVS hosts. Change this value (e.g., increment a number or set a new timestamp) to trigger a re-sync without modifying other fields.

clusterName String: The name of the AVS cluster.
privateCloudName String: The name of the AVS private cloud.
resourceGroup String: The resource group of the AVS private cloud.
syncTrigger String: An arbitrary value that, when changed, forces a re-sync of AVS hosts. Change this value (e.g., increment a number or set a new timestamp) to trigger a re-sync without modifying other fields.

Package Details

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

Viewing docs for netapp-cloudmanager 27.1.0
published on Friday, Mar 20, 2026 by netapp

Schema (JSON)

netapp/terraform-provider-netapp-cloudmanager

netapp-cloudmanager.Volume

On this page

On this page

Create Volume Resource

Constructor syntax

Parameters

Constructor example

Volume Resource Properties

Inputs

Outputs

Look up Existing Volume Resource

Supporting Types

VolumeAvsIntegration, VolumeAvsIntegrationArgs

VolumeInitiator, VolumeInitiatorArgs

VolumeSnapshotPolicy, VolumeSnapshotPolicyArgs

VolumeSnapshotPolicySchedule, VolumeSnapshotPolicyScheduleArgs

VolumeSyncAvsHosts, VolumeSyncAvsHostsArgs

Package Details

On this page

On this page