AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon FSx UpdateVolume API operation.

Syntax

Update-FSXVolume
-VolumeId <String>
-SnaplockConfiguration_AuditLogVolume <Boolean>
-ClientRequestToken <String>
-TieringPolicy_CoolingPeriod <Int32>
-OntapConfiguration_CopyTagsToBackup <Boolean>
-OpenZFSConfiguration_DataCompressionType <OpenZFSDataCompressionType>
-OntapConfiguration_JunctionPath <String>
-Name <String>
-TieringPolicy_Name <TieringPolicyName>
-OpenZFSConfiguration_NfsExport <OpenZFSNfsExport[]>
-SnaplockConfiguration_PrivilegedDelete <PrivilegedDelete>
-OpenZFSConfiguration_ReadOnly <Boolean>
-OpenZFSConfiguration_RecordSizeKiB <Int32>
-OntapConfiguration_SecurityStyle <SecurityStyle>
-OntapConfiguration_SizeInByte <Int64>
-OntapConfiguration_SizeInMegabyte <Int32>
-OntapConfiguration_SnapshotPolicy <String>
-OpenZFSConfiguration_StorageCapacityQuotaGiB <Int32>
-OpenZFSConfiguration_StorageCapacityReservationGiB <Int32>
-OntapConfiguration_StorageEfficiencyEnabled <Boolean>
-AutocommitPeriod_Type <AutocommitPeriodType>
-DefaultRetention_Type <RetentionPeriodType>
-MaximumRetention_Type <RetentionPeriodType>
-MinimumRetention_Type <RetentionPeriodType>
-OpenZFSConfiguration_UserAndGroupQuota <OpenZFSUserOrGroupQuota[]>
-AutocommitPeriod_Value <Int32>
-DefaultRetention_Value <Int32>
-MaximumRetention_Value <Int32>
-MinimumRetention_Value <Int32>
-SnaplockConfiguration_VolumeAppendModeEnabled <Boolean>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonFSxConfig>

Description

Updates the configuration of an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.

Parameters

-AutocommitPeriod_Type <AutocommitPeriodType>
Defines the type of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. Setting this value to NONE disables autocommit. The default value is NONE.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOntapConfiguration_SnaplockConfiguration_AutocommitPeriod_Type
-AutocommitPeriod_Value <Int32>
Defines the amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. The following ranges are valid:
  • Minutes: 5 - 65,535
  • Hours: 1 - 65,535
  • Days: 1 - 3,650
  • Months: 1 - 120
  • Years: 1 - 10
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOntapConfiguration_SnaplockConfiguration_AutocommitPeriod_Value
-ClientConfig <AmazonFSxConfig>
Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientRequestToken <String>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultRetention_Type <RetentionPeriodType>
Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOntapConfiguration_SnaplockConfiguration_RetentionPeriod_DefaultRetention_Type
-DefaultRetention_Value <Int32>
Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for INFINITE or UNSPECIFIED. For all other options, the following ranges are valid:
  • Seconds: 0 - 65,535
  • Minutes: 0 - 65,535
  • Hours: 0 - 24
  • Days: 0 - 365
  • Months: 0 - 12
  • Years: 0 - 100
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOntapConfiguration_SnaplockConfiguration_RetentionPeriod_DefaultRetention_Value
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MaximumRetention_Type <RetentionPeriodType>
Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOntapConfiguration_SnaplockConfiguration_RetentionPeriod_MaximumRetention_Type
-MaximumRetention_Value <Int32>
Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for INFINITE or UNSPECIFIED. For all other options, the following ranges are valid:
  • Seconds: 0 - 65,535
  • Minutes: 0 - 65,535
  • Hours: 0 - 24
  • Days: 0 - 365
  • Months: 0 - 12
  • Years: 0 - 100
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOntapConfiguration_SnaplockConfiguration_RetentionPeriod_MaximumRetention_Value
-MinimumRetention_Type <RetentionPeriodType>
Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOntapConfiguration_SnaplockConfiguration_RetentionPeriod_MinimumRetention_Type
-MinimumRetention_Value <Int32>
Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for INFINITE or UNSPECIFIED. For all other options, the following ranges are valid:
  • Seconds: 0 - 65,535
  • Minutes: 0 - 65,535
  • Hours: 0 - 24
  • Days: 0 - 365
  • Months: 0 - 12
  • Years: 0 - 100
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOntapConfiguration_SnaplockConfiguration_RetentionPeriod_MinimumRetention_Value
-Name <String>
The name of the OpenZFS volume. OpenZFS root volumes are automatically named FSX. Child volume names must be unique among their parent volume's children. The name of the volume is part of the mount string for the OpenZFS volume.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OntapConfiguration_CopyTagsToBackup <Boolean>
A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOntapConfiguration_CopyTagsToBackups
-OntapConfiguration_JunctionPath <String>
Specifies the location in the SVM's namespace where the volume is mounted. The JunctionPath must have a leading forward slash, such as /vol3.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OntapConfiguration_SecurityStyle <SecurityStyle>
The security style for the volume, which can be UNIX, NTFS, or MIXED.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OntapConfiguration_SizeInByte <Int64>
The configured size of the volume, in bytes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOntapConfiguration_SizeInBytes
-OntapConfiguration_SizeInMegabyte <Int32>
Specifies the size of the volume in megabytes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOntapConfiguration_SizeInMegabytes
-OntapConfiguration_SnapshotPolicy <String>
Specifies the snapshot policy for the volume. There are three built-in snapshot policies:
  • default: This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight.
  • default-1weekly: This policy is the same as the default policy except that it only retains one snapshot from the weekly schedule.
  • none: This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.
You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OntapConfiguration_StorageEfficiencyEnabled <Boolean>
Default is false. Set to true to enable the deduplication, compression, and compaction storage efficiency features on the volume.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OpenZFSConfiguration_DataCompressionType <OpenZFSDataCompressionType>
Specifies the method used to compress the data on the volume. The compression type is NONE by default.
  • NONE - Doesn't compress the data on the volume. NONE is the default.
  • ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.
  • LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OpenZFSConfiguration_NfsExport <OpenZFSNfsExport[]>
The configuration object for mounting a Network File System (NFS) file system.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOpenZFSConfiguration_NfsExports
-OpenZFSConfiguration_ReadOnly <Boolean>
A Boolean value indicating whether the volume is read-only.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OpenZFSConfiguration_RecordSizeKiB <Int32>
Specifies the record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. Database workflows can benefit from a smaller record size, while streaming workflows can benefit from a larger record size. For additional guidance on when to set a custom record size, see Tips for maximizing performance in the Amazon FSx for OpenZFS User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OpenZFSConfiguration_StorageCapacityQuotaGiB <Int32>
The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume. You can specify a value of -1 to unset a volume's storage capacity quota.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OpenZFSConfiguration_StorageCapacityReservationGiB <Int32>
The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved. You can specify a value of -1 to unset a volume's storage capacity reservation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OpenZFSConfiguration_UserAndGroupQuota <OpenZFSUserOrGroupQuota[]>
An object specifying how much storage users or groups can use on the volume.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOpenZFSConfiguration_UserAndGroupQuotas
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the VolumeId parameter. The -PassThru parameter is deprecated, use -Select '^VolumeId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'Volume'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.UpdateVolumeResponse). Specifying the name of a property of type Amazon.FSx.Model.UpdateVolumeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SnaplockConfiguration_AuditLogVolume <Boolean>
Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is false. If you set AuditLogVolume to true, the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months. For more information, see SnapLock audit log volumes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOntapConfiguration_SnaplockConfiguration_AuditLogVolume
-SnaplockConfiguration_PrivilegedDelete <PrivilegedDelete>
Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even if they have active retention periods. PERMANENTLY_DISABLED is a terminal state. If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default value is DISABLED. For more information, see Privileged delete.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOntapConfiguration_SnaplockConfiguration_PrivilegedDelete
-SnaplockConfiguration_VolumeAppendModeEnabled <Boolean>
Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is false. For more information, see Volume-append mode.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOntapConfiguration_SnaplockConfiguration_VolumeAppendModeEnabled
-TieringPolicy_CoolingPeriod <Int32>
Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool. Used with the AUTO and SNAPSHOT_ONLY tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for AUTO and 2 days for SNAPSHOT_ONLY.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOntapConfiguration_TieringPolicy_CoolingPeriod
-TieringPolicy_Name <TieringPolicyName>
Specifies the tiering policy used to transition data. Default value is SNAPSHOT_ONLY.
  • SNAPSHOT_ONLY - moves cold snapshots to the capacity pool storage tier.
  • AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.
  • ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.
  • NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOntapConfiguration_TieringPolicy_Name
-VolumeId <String>
The ID of the volume that you want to update, in the format fsvol-0123456789abcdef0.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.FSx.Model.Volume or Amazon.FSx.Model.UpdateVolumeResponse
This cmdlet returns an Amazon.FSx.Model.Volume object. The service call response (type Amazon.FSx.Model.UpdateVolumeResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Amazon FSx for Windows File Server User Guide
Amazon FSx for Lustre User Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z