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 UpdateFileSystem API operation.

Syntax

Update-FSXFileSystem
-FileSystemId <String>
-OntapConfiguration_AddRouteTableId <String[]>
-OpenZFSConfiguration_AddRouteTableId <String[]>
-OntapConfiguration_AutomaticBackupRetentionDay <Int32>
-OpenZFSConfiguration_AutomaticBackupRetentionDay <Int32>
-ClientRequestToken <String>
-OpenZFSConfiguration_CopyTagsToBackup <Boolean>
-OpenZFSConfiguration_CopyTagsToVolume <Boolean>
-OntapConfiguration_DailyAutomaticBackupStartTime <String>
-OpenZFSConfiguration_DailyAutomaticBackupStartTime <String>
-OntapConfiguration_FsxAdminPassword <String>
-OntapConfiguration_HAPair <Int32>
-OntapConfiguration_DiskIopsConfiguration_Iops <Int64>
-OpenZFSConfiguration_DiskIopsConfiguration_Iops <Int64>
-LustreConfiguration <UpdateFileSystemLustreConfiguration>
-OntapConfiguration_DiskIopsConfiguration_Mode <DiskIopsConfigurationMode>
-OpenZFSConfiguration_DiskIopsConfiguration_Mode <DiskIopsConfigurationMode>
-OntapConfiguration_RemoveRouteTableId <String[]>
-OpenZFSConfiguration_RemoveRouteTableId <String[]>
-StorageCapacity <Int32>
-StorageType <StorageType>
-OntapConfiguration_ThroughputCapacity <Int32>
-OpenZFSConfiguration_ThroughputCapacity <Int32>
-OntapConfiguration_ThroughputCapacityPerHAPair <Int32>
-OntapConfiguration_WeeklyMaintenanceStartTime <String>
-OpenZFSConfiguration_WeeklyMaintenanceStartTime <String>
-WindowsConfiguration <UpdateFileSystemWindowsConfiguration>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonFSxConfig>

Description

Use this operation to update the configuration of an existing Amazon FSx file system. You can update multiple properties in a single request. For FSx for Windows File Server file systems, you can update the following properties:
  • AuditLogConfiguration
  • AutomaticBackupRetentionDays
  • DailyAutomaticBackupStartTime
  • SelfManagedActiveDirectoryConfiguration
  • StorageCapacity
  • StorageType
  • ThroughputCapacity
  • DiskIopsConfiguration
  • WeeklyMaintenanceStartTime
For FSx for Lustre file systems, you can update the following properties:
  • AutoImportPolicy
  • AutomaticBackupRetentionDays
  • DailyAutomaticBackupStartTime
  • DataCompressionType
  • LogConfiguration
  • LustreRootSquashConfiguration
  • MetadataConfiguration
  • PerUnitStorageThroughput
  • StorageCapacity
  • WeeklyMaintenanceStartTime
For FSx for ONTAP file systems, you can update the following properties:
  • AddRouteTableIds
  • AutomaticBackupRetentionDays
  • DailyAutomaticBackupStartTime
  • DiskIopsConfiguration
  • FsxAdminPassword
  • HAPairs
  • RemoveRouteTableIds
  • StorageCapacity
  • ThroughputCapacity
  • ThroughputCapacityPerHAPair
  • WeeklyMaintenanceStartTime
For FSx for OpenZFS file systems, you can update the following properties:
  • AddRouteTableIds
  • AutomaticBackupRetentionDays
  • CopyTagsToBackups
  • CopyTagsToVolumes
  • DailyAutomaticBackupStartTime
  • DiskIopsConfiguration
  • RemoveRouteTableIds
  • StorageCapacity
  • ThroughputCapacity
  • WeeklyMaintenanceStartTime

Parameters

-ClientConfig <AmazonFSxConfig>
Amazon.PowerShell.Cmdlets.FSX.AmazonFSxClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientRequestToken <String>
A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent updates. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FileSystemId <String>
The ID of the file system that you are updating.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-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)
-LustreConfiguration <UpdateFileSystemLustreConfiguration>
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)
-OntapConfiguration_AddRouteTableId <String[]>
(Multi-AZ only) A list of IDs of new virtual private cloud (VPC) route tables to associate (add) with your Amazon FSx for NetApp ONTAP file system.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOntapConfiguration_AddRouteTableIds
-OntapConfiguration_AutomaticBackupRetentionDay <Int32>
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)
AliasesOntapConfiguration_AutomaticBackupRetentionDays
-OntapConfiguration_DailyAutomaticBackupStartTime <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)
-OntapConfiguration_DiskIopsConfiguration_Iops <Int64>
The total number of SSD IOPS provisioned for the file system.The minimum and maximum values for this property depend on the value of HAPairs and StorageCapacity. The minimum value is calculated as StorageCapacity * 3 * HAPairs (3 IOPS per GB of StorageCapacity). The maximum value is calculated as 200,000 * HAPairs.Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of Iops is outside of the minimum or maximum values.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OntapConfiguration_DiskIopsConfiguration_Mode <DiskIopsConfigurationMode>
Specifies whether the file system is using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a USER_PROVISIONED value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OntapConfiguration_FsxAdminPassword <String>
Update the password for the fsxadmin user by entering a new password. You use the fsxadmin user to access the NetApp ONTAP CLI and REST API to manage your file system resources. For more information, see Managing resources using NetApp Applicaton.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OntapConfiguration_HAPair <Int32>
Use to update the number of high-availability (HA) pairs for a second-generation single-AZ file system. If you increase the number of HA pairs for your file system, you must specify proportional increases for StorageCapacity, Iops, and ThroughputCapacity. For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide. Block storage protocol support (iSCSI and NVMe over TCP) is disabled on file systems with more than 6 HA pairs. For more information, see Using block storage protocols.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOntapConfiguration_HAPairs
-OntapConfiguration_RemoveRouteTableId <String[]>
(Multi-AZ only) A list of IDs of existing virtual private cloud (VPC) route tables to disassociate (remove) from your Amazon FSx for NetApp ONTAP file system. You can use the API operation to retrieve the list of VPC route table IDs for a file system.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOntapConfiguration_RemoveRouteTableIds
-OntapConfiguration_ThroughputCapacity <Int32>
Enter a new value to change the amount of throughput capacity for the file system in megabytes per second (MBps). For more information, see Managing throughput capacity in the FSx for ONTAP User Guide.Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
  • The value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value.
  • The value of ThroughputCapacity when divided by the value of HAPairs is outside of the valid range for ThroughputCapacity.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OntapConfiguration_ThroughputCapacityPerHAPair <Int32>
Use to choose the throughput capacity per HA pair, rather than the total throughput for the file system. This field and ThroughputCapacity cannot be defined in the same API call, but one is required.This field and ThroughputCapacity are the same for file systems with one HA pair.
  • For SINGLE_AZ_1 and MULTI_AZ_1 file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.
  • For SINGLE_AZ_2, valid values are 1536, 3072, or 6144 MBps.
  • For MULTI_AZ_2, valid values are 384, 768, 1536, 3072, or 6144 MBps.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
  • The value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value for file systems with one HA pair.
  • The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is not a valid HA pair (a value between 1 and 12).
  • The value of ThroughputCapacityPerHAPair is not a valid value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OntapConfiguration_WeeklyMaintenanceStartTime <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)
-OpenZFSConfiguration_AddRouteTableId <String[]>
(Multi-AZ only) A list of IDs of new virtual private cloud (VPC) route tables to associate (add) with your Amazon FSx for OpenZFS file system.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOpenZFSConfiguration_AddRouteTableIds
-OpenZFSConfiguration_AutomaticBackupRetentionDay <Int32>
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)
AliasesOpenZFSConfiguration_AutomaticBackupRetentionDays
-OpenZFSConfiguration_CopyTagsToBackup <Boolean>
A Boolean value indicating whether tags for the file system should be copied to backups. This value defaults to false. If it's set to true, all tags for the file system 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 file system, regardless of this value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOpenZFSConfiguration_CopyTagsToBackups
-OpenZFSConfiguration_CopyTagsToVolume <Boolean>
A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots 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 snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOpenZFSConfiguration_CopyTagsToVolumes
-OpenZFSConfiguration_DailyAutomaticBackupStartTime <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)
-OpenZFSConfiguration_DiskIopsConfiguration_Iops <Int64>
The total number of SSD IOPS provisioned for the file system.The minimum and maximum values for this property depend on the value of HAPairs and StorageCapacity. The minimum value is calculated as StorageCapacity * 3 * HAPairs (3 IOPS per GB of StorageCapacity). The maximum value is calculated as 200,000 * HAPairs.Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of Iops is outside of the minimum or maximum values.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OpenZFSConfiguration_DiskIopsConfiguration_Mode <DiskIopsConfigurationMode>
Specifies whether the file system is using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a USER_PROVISIONED value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OpenZFSConfiguration_RemoveRouteTableId <String[]>
(Multi-AZ only) A list of IDs of existing virtual private cloud (VPC) route tables to disassociate (remove) from your Amazon FSx for OpenZFS file system. You can use the API operation to retrieve the list of VPC route table IDs for a file system.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOpenZFSConfiguration_RemoveRouteTableIds
-OpenZFSConfiguration_ThroughputCapacity <Int32>
The throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MB/s). Valid values depend on the DeploymentType you choose, as follows:
  • For MULTI_AZ_1 and SINGLE_AZ_2, valid values are 160, 320, 640, 1280, 2560, 3840, 5120, 7680, or 10240 MB/s.
  • For SINGLE_AZ_1, valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MB/s.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OpenZFSConfiguration_WeeklyMaintenanceStartTime <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)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the FileSystemId parameter. The -PassThru parameter is deprecated, use -Select '^FileSystemId' 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 'FileSystem'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.UpdateFileSystemResponse). Specifying the name of a property of type Amazon.FSx.Model.UpdateFileSystemResponse 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)
-StorageCapacity <Int32>
Use this parameter to increase the storage capacity of an FSx for Windows File Server, FSx for Lustre, FSx for OpenZFS, or FSx for ONTAP file system. Specifies the storage capacity target value, in GiB, to increase the storage capacity for the file system that you're updating. You can't make a storage capacity increase request if there is an existing storage capacity increase request in progress.For Lustre file systems, the storage capacity target value can be the following:
  • For SCRATCH_2, PERSISTENT_1, and PERSISTENT_2 SSD deployment types, valid values are in multiples of 2400 GiB. The value must be greater than the current storage capacity.
  • For PERSISTENT HDD file systems, valid values are multiples of 6000 GiB for 12-MBps throughput per TiB file systems and multiples of 1800 GiB for 40-MBps throughput per TiB file systems. The values must be greater than the current storage capacity.
  • For SCRATCH_1 file systems, you can't increase the storage capacity.
For more information, see Managing storage and throughput capacity in the FSx for Lustre User Guide.For FSx for OpenZFS file systems, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. For more information, see Managing storage capacity in the FSx for OpenZFS User Guide.For Windows file systems, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. To increase storage capacity, the file system must have at least 16 MBps of throughput capacity. For more information, see Managing storage capacity in the Amazon FSxfor Windows File Server User Guide.For ONTAP file systems, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. For more information, see Managing storage capacity and provisioned IOPS in the Amazon FSx for NetApp ONTAP User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageType <StorageType>
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)
-WindowsConfiguration <UpdateFileSystemWindowsConfiguration>
The configuration updates for an Amazon FSx for Windows File Server file system.
Required?False
Position?Named
Accept pipeline input?True (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.FileSystem or Amazon.FSx.Model.UpdateFileSystemResponse
This cmdlet returns an Amazon.FSx.Model.FileSystem object. The service call response (type Amazon.FSx.Model.UpdateFileSystemResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Examples

Example 1

$UpdateFSXWinConfig = [Amazon.FSx.Model.UpdateFileSystemWindowsConfiguration]::new()
	$UpdateFSXWinConfig.AutomaticBackupRetentionDays = 35
	Update-FSXFileSystem -FileSystemId $FSX.FileSystemId -WindowsConfiguration $UpdateFSXWinConfig

CreationTime         : 1/17/2019 9:55:30 AM
DNSName              : fs-01cd23bc4bdf5678a.ktmsad.local
FailureDetails       :
FileSystemId         : fs-01cd23bc4bdf5678a
FileSystemType       : WINDOWS
KmsKeyId             : arn:aws:kms:eu-west-1:123456789012:key/f1af23c4-1b23-1bde-a1f2-e1234c5af678
Lifecycle            : AVAILABLE
LustreConfiguration  :
NetworkInterfaceIds  : {eni-01cd23bc4bdf5678a}
OwnerId              : 933303704102
ResourceARN          : arn:aws:fsx:eu-west-1:933303704102:file-system/fs-07cd45bc6bdf2674a
StorageCapacity      : 300
SubnetIds            : {subnet-1d234567}
Tags                 : {FSx-Service}
VpcId                : vpc-23cf4b5f
WindowsConfiguration : Amazon.FSx.Model.WindowsFileSystemConfiguration
This example updates the FSX file system automatic backup retention days via UpdateFileSystemWindowsConfiguration.
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