Skip to content

/AWS1/CL_FSXUPFILESYSTEMONTA00

The configuration updates for an Amazon FSx for NetApp ONTAP file system.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_automaticbackupretdays TYPE /AWS1/FSXAUTOMATICBACKUPRETD00 /AWS1/FSXAUTOMATICBACKUPRETD00

AutomaticBackupRetentionDays

iv_dailyautomaticbackupstr00 TYPE /AWS1/FSXDAILYTIME /AWS1/FSXDAILYTIME

DailyAutomaticBackupStartTime

iv_fsxadminpassword TYPE /AWS1/FSXADMINPASSWORD /AWS1/FSXADMINPASSWORD

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 Application.

iv_weeklymaintenancestrttime TYPE /AWS1/FSXWEEKLYTIME /AWS1/FSXWEEKLYTIME

WeeklyMaintenanceStartTime

io_diskiopsconfiguration TYPE REF TO /AWS1/CL_FSXDISKIOPSCONF /AWS1/CL_FSXDISKIOPSCONF

The SSD IOPS (input output operations per second) configuration for an Amazon FSx for NetApp ONTAP file system. The default is 3 IOPS per GB of storage capacity, but you can provision additional IOPS per GB of storage. The configuration consists of an IOPS mode (AUTOMATIC or USER_PROVISIONED), and in the case of USER_PROVISIONED IOPS, the total number of SSD IOPS provisioned. For more information, see File system storage capacity and IOPS.

iv_throughputcapacity TYPE /AWS1/FSXMEGABYTESPERSECOND /AWS1/FSXMEGABYTESPERSECOND

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.

it_addroutetableids TYPE /AWS1/CL_FSXROUTETABLEIDS_W=>TT_ROUTETABLEIDS TT_ROUTETABLEIDS

(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.

it_removeroutetableids TYPE /AWS1/CL_FSXROUTETABLEIDS_W=>TT_ROUTETABLEIDS TT_ROUTETABLEIDS

(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.

iv_thruputcapacityperhapair TYPE /AWS1/FSXTHRUPUTCAPPERHAPAIR /AWS1/FSXTHRUPUTCAPPERHAPAIR

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.

iv_hapairs TYPE /AWS1/FSXHAPAIRS /AWS1/FSXHAPAIRS

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.

iv_endpointipv6addressrange TYPE /AWS1/FSXIPV6ADDRESSRANGE /AWS1/FSXIPV6ADDRESSRANGE

(Multi-AZ only) Specifies the IPv6 address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx selects an available /118 IP address range for you from one of the VPC's CIDR ranges. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables, as long as they don't overlap with any subnet.

Queryable Attributes

AutomaticBackupRetentionDays

AutomaticBackupRetentionDays

Accessible with the following methods

Method Description
GET_AUTOMATICBACKUPRETDAYS() Getter for AUTOMATICBACKUPRETENTIONDAYS, with configurable d
ASK_AUTOMATICBACKUPRETDAYS() Getter for AUTOMATICBACKUPRETENTIONDAYS w/ exceptions if fie
HAS_AUTOMATICBACKUPRETDAYS() Determine if AUTOMATICBACKUPRETENTIONDAYS has a value

DailyAutomaticBackupStartTime

DailyAutomaticBackupStartTime

Accessible with the following methods

Method Description
GET_DAILYAUTOMATICBACKUPST00() Getter for DAILYAUTOMATICBACKUPSTRTTIME, with configurable d
ASK_DAILYAUTOMATICBACKUPST00() Getter for DAILYAUTOMATICBACKUPSTRTTIME w/ exceptions if fie
HAS_DAILYAUTOMATICBACKUPST00() Determine if DAILYAUTOMATICBACKUPSTRTTIME has a value

FsxAdminPassword

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 Application.

Accessible with the following methods

Method Description
GET_FSXADMINPASSWORD() Getter for FSXADMINPASSWORD, with configurable default
ASK_FSXADMINPASSWORD() Getter for FSXADMINPASSWORD w/ exceptions if field has no va
HAS_FSXADMINPASSWORD() Determine if FSXADMINPASSWORD has a value

WeeklyMaintenanceStartTime

WeeklyMaintenanceStartTime

Accessible with the following methods

Method Description
GET_WEEKLYMAINTENANCESTRTT00() Getter for WEEKLYMAINTENANCESTARTTIME, with configurable def
ASK_WEEKLYMAINTENANCESTRTT00() Getter for WEEKLYMAINTENANCESTARTTIME w/ exceptions if field
HAS_WEEKLYMAINTENANCESTRTT00() Determine if WEEKLYMAINTENANCESTARTTIME has a value

DiskIopsConfiguration

The SSD IOPS (input output operations per second) configuration for an Amazon FSx for NetApp ONTAP file system. The default is 3 IOPS per GB of storage capacity, but you can provision additional IOPS per GB of storage. The configuration consists of an IOPS mode (AUTOMATIC or USER_PROVISIONED), and in the case of USER_PROVISIONED IOPS, the total number of SSD IOPS provisioned. For more information, see File system storage capacity and IOPS.

Accessible with the following methods

Method Description
GET_DISKIOPSCONFIGURATION() Getter for DISKIOPSCONFIGURATION

ThroughputCapacity

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.

Accessible with the following methods

Method Description
GET_THROUGHPUTCAPACITY() Getter for THROUGHPUTCAPACITY, with configurable default
ASK_THROUGHPUTCAPACITY() Getter for THROUGHPUTCAPACITY w/ exceptions if field has no
HAS_THROUGHPUTCAPACITY() Determine if THROUGHPUTCAPACITY has a value

AddRouteTableIds

(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.

Accessible with the following methods

Method Description
GET_ADDROUTETABLEIDS() Getter for ADDROUTETABLEIDS, with configurable default
ASK_ADDROUTETABLEIDS() Getter for ADDROUTETABLEIDS w/ exceptions if field has no va
HAS_ADDROUTETABLEIDS() Determine if ADDROUTETABLEIDS has a value

RemoveRouteTableIds

(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.

Accessible with the following methods

Method Description
GET_REMOVEROUTETABLEIDS() Getter for REMOVEROUTETABLEIDS, with configurable default
ASK_REMOVEROUTETABLEIDS() Getter for REMOVEROUTETABLEIDS w/ exceptions if field has no
HAS_REMOVEROUTETABLEIDS() Determine if REMOVEROUTETABLEIDS has a value

ThroughputCapacityPerHAPair

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.

Accessible with the following methods

Method Description
GET_THRUPUTCAPACITYPERHAPAIR() Getter for THROUGHPUTCAPACITYPERHAPAIR, with configurable de
ASK_THRUPUTCAPACITYPERHAPAIR() Getter for THROUGHPUTCAPACITYPERHAPAIR w/ exceptions if fiel
HAS_THRUPUTCAPACITYPERHAPAIR() Determine if THROUGHPUTCAPACITYPERHAPAIR has a value

HAPairs

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.

Accessible with the following methods

Method Description
GET_HAPAIRS() Getter for HAPAIRS, with configurable default
ASK_HAPAIRS() Getter for HAPAIRS w/ exceptions if field has no value
HAS_HAPAIRS() Determine if HAPAIRS has a value

EndpointIpv6AddressRange

(Multi-AZ only) Specifies the IPv6 address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx selects an available /118 IP address range for you from one of the VPC's CIDR ranges. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables, as long as they don't overlap with any subnet.

Accessible with the following methods

Method Description
GET_ENDPOINTIPV6ADDRESSRANGE() Getter for ENDPOINTIPV6ADDRESSRANGE, with configurable defau
ASK_ENDPOINTIPV6ADDRESSRANGE() Getter for ENDPOINTIPV6ADDRESSRANGE w/ exceptions if field h
HAS_ENDPOINTIPV6ADDRESSRANGE() Determine if ENDPOINTIPV6ADDRESSRANGE has a value