/AWS1/CL_FSXADMINISTRATIVEACT

Describes a specific Amazon FSx administrative action for the current Windows, Lustre, OpenZFS, or ONTAP file system or volume.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_administrativeactiontype TYPE /AWS1/FSXADMINISTRATIVEACTTYPE /AWS1/FSXADMINISTRATIVEACTTYPE

Describes the type of administrative action, as follows:

• FILE_SYSTEM_UPDATE - A file system update administrative action initiated from the Amazon FSx console, API (UpdateFileSystem), or CLI (update-file-system).

• THROUGHPUT_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's throughput capacity has been completed successfully, a THROUGHPUT_OPTIMIZATION task starts.

  You can track the storage-optimization progress using the ProgressPercent property. When THROUGHPUT_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information, see Managing throughput capacity in the Amazon FSx for Windows File Server User Guide.

• STORAGE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's storage capacity has completed successfully, a STORAGE_OPTIMIZATION task starts.

  • For Windows and ONTAP, storage optimization is the process of migrating the file system data to newer larger disks.

  • For Lustre, storage optimization consists of rebalancing the data across the existing and newly added file servers.

  You can track the storage-optimization progress using the ProgressPercent property. When STORAGE_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide, Managing storage capacity in the Amazon FSx for Lustre User Guide, and Managing storage capacity and provisioned IOPS in the Amazon FSx for NetApp ONTAP User Guide.

• FILE_SYSTEM_ALIAS_ASSOCIATION - A file system update to associate a new Domain Name System (DNS) alias with the file system. For more information, see AssociateFileSystemAliases.

• FILE_SYSTEM_ALIAS_DISASSOCIATION - A file system update to disassociate a DNS alias from the file system. For more information, see DisassociateFileSystemAliases.

• IOPS_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's throughput capacity has been completed successfully, a IOPS_OPTIMIZATION task starts.

  You can track the storage-optimization progress using the ProgressPercent property. When IOPS_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information, see Managing provisioned SSD IOPS in the Amazon FSx for Windows File Server User Guide.

• STORAGE_TYPE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's throughput capacity has been completed successfully, a STORAGE_TYPE_OPTIMIZATION task starts.

  You can track the storage-optimization progress using the ProgressPercent property. When STORAGE_TYPE_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED.

• VOLUME_UPDATE - A volume update to an Amazon FSx for OpenZFS volume initiated from the Amazon FSx console, API (UpdateVolume), or CLI (update-volume).

• VOLUME_RESTORE - An Amazon FSx for OpenZFS volume is returned to the state saved by the specified snapshot, initiated from an API (RestoreVolumeFromSnapshot) or CLI (restore-volume-from-snapshot).

• SNAPSHOT_UPDATE - A snapshot update to an Amazon FSx for OpenZFS volume initiated from the Amazon FSx console, API (UpdateSnapshot), or CLI (update-snapshot).

• RELEASE_NFS_V3_LOCKS - Tracks the release of Network File System (NFS) V3 locks on an Amazon FSx for OpenZFS file system.

• DOWNLOAD_DATA_FROM_BACKUP - An FSx for ONTAP backup is being restored to a new volume on a second-generation file system. Once the all the file metadata is loaded onto the volume, you can mount the volume with read-only access. during this process.

• VOLUME_INITIALIZE_WITH_SNAPSHOT - A volume is being created from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API (CreateVolume), or CLI (create-volume) when using the using the FULL_COPY strategy.

• VOLUME_UPDATE_WITH_SNAPSHOT - A volume is being updated from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API (CopySnapshotAndUpdateVolume), or CLI (copy-snapshot-and-update-volume).

iv_progresspercent TYPE /AWS1/FSXPROGRESSPERCENT /AWS1/FSXPROGRESSPERCENT

The percentage-complete status of a STORAGE_OPTIMIZATION or DOWNLOAD_DATA_FROM_BACKUP administrative action. Does not apply to any other administrative action type.

iv_requesttime TYPE /AWS1/FSXREQUESTTIME /AWS1/FSXREQUESTTIME

The time that the administrative action request was received.

iv_status TYPE /AWS1/FSXSTATUS /AWS1/FSXSTATUS

The status of the administrative action, as follows:

• FAILED - Amazon FSx failed to process the administrative action successfully.

• IN_PROGRESS - Amazon FSx is processing the administrative action.

• PENDING - Amazon FSx is waiting to process the administrative action.

• COMPLETED - Amazon FSx has finished processing the administrative task.

  For a backup restore to a second-generation FSx for ONTAP file system, indicates that all data has been downloaded to the volume, and clients now have read-write access to volume.

• UPDATED_OPTIMIZING - For a storage-capacity increase update, Amazon FSx has updated the file system with the new storage capacity, and is now performing the storage-optimization process.

• PENDING - For a backup restore to a second-generation FSx for ONTAP file system, indicates that the file metadata is being downloaded onto the volume. The volume's Lifecycle state is CREATING.

• IN_PROGRESS - For a backup restore to a second-generation FSx for ONTAP file system, indicates that all metadata has been downloaded to the new volume and client can access data with read-only access while Amazon FSx downloads the file data to the volume. Track the progress of this process with the ProgressPercent element.

io_targetfilesystemvalues TYPE REF TO /AWS1/CL_FSXFILESYSTEM /AWS1/CL_FSXFILESYSTEM

The target value for the administration action, provided in the UpdateFileSystem operation. Returned for FILE_SYSTEM_UPDATE administrative actions.

io_failuredetails TYPE REF TO /AWS1/CL_FSXADMINISTRATIVEAC00 /AWS1/CL_FSXADMINISTRATIVEAC00

Provides information about a failed administrative action.

io_targetvolumevalues TYPE REF TO /AWS1/CL_FSXVOLUME /AWS1/CL_FSXVOLUME

Describes an Amazon FSx volume.

io_targetsnapshotvalues TYPE REF TO /AWS1/CL_FSXSNAPSHOT /AWS1/CL_FSXSNAPSHOT

A snapshot of an Amazon FSx for OpenZFS volume.

iv_totaltransferbytes TYPE /AWS1/FSXTOTALTRANSFERBYTES /AWS1/FSXTOTALTRANSFERBYTES

The number of bytes that have transferred for the FSx for OpenZFS snapshot that you're copying.

iv_remainingtransferbytes TYPE /AWS1/FSXREMAININGXFERBYTES /AWS1/FSXREMAININGXFERBYTES

The remaining bytes to transfer for the FSx for OpenZFS snapshot that you're copying.

iv_message TYPE /AWS1/FSXERRORMESSAGE /AWS1/FSXERRORMESSAGE

A detailed error message.

---

Queryable Attributes

AdministrativeActionType

Describes the type of administrative action, as follows:

• FILE_SYSTEM_UPDATE - A file system update administrative action initiated from the Amazon FSx console, API (UpdateFileSystem), or CLI (update-file-system).

• THROUGHPUT_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's throughput capacity has been completed successfully, a THROUGHPUT_OPTIMIZATION task starts.

  You can track the storage-optimization progress using the ProgressPercent property. When THROUGHPUT_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information, see Managing throughput capacity in the Amazon FSx for Windows File Server User Guide.

• STORAGE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's storage capacity has completed successfully, a STORAGE_OPTIMIZATION task starts.

  • For Windows and ONTAP, storage optimization is the process of migrating the file system data to newer larger disks.

  • For Lustre, storage optimization consists of rebalancing the data across the existing and newly added file servers.

  You can track the storage-optimization progress using the ProgressPercent property. When STORAGE_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide, Managing storage capacity in the Amazon FSx for Lustre User Guide, and Managing storage capacity and provisioned IOPS in the Amazon FSx for NetApp ONTAP User Guide.

• FILE_SYSTEM_ALIAS_ASSOCIATION - A file system update to associate a new Domain Name System (DNS) alias with the file system. For more information, see AssociateFileSystemAliases.

• FILE_SYSTEM_ALIAS_DISASSOCIATION - A file system update to disassociate a DNS alias from the file system. For more information, see DisassociateFileSystemAliases.

• IOPS_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's throughput capacity has been completed successfully, a IOPS_OPTIMIZATION task starts.

  You can track the storage-optimization progress using the ProgressPercent property. When IOPS_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information, see Managing provisioned SSD IOPS in the Amazon FSx for Windows File Server User Guide.

• STORAGE_TYPE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's throughput capacity has been completed successfully, a STORAGE_TYPE_OPTIMIZATION task starts.

  You can track the storage-optimization progress using the ProgressPercent property. When STORAGE_TYPE_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED.

• VOLUME_UPDATE - A volume update to an Amazon FSx for OpenZFS volume initiated from the Amazon FSx console, API (UpdateVolume), or CLI (update-volume).

• VOLUME_RESTORE - An Amazon FSx for OpenZFS volume is returned to the state saved by the specified snapshot, initiated from an API (RestoreVolumeFromSnapshot) or CLI (restore-volume-from-snapshot).

• SNAPSHOT_UPDATE - A snapshot update to an Amazon FSx for OpenZFS volume initiated from the Amazon FSx console, API (UpdateSnapshot), or CLI (update-snapshot).

• RELEASE_NFS_V3_LOCKS - Tracks the release of Network File System (NFS) V3 locks on an Amazon FSx for OpenZFS file system.

• DOWNLOAD_DATA_FROM_BACKUP - An FSx for ONTAP backup is being restored to a new volume on a second-generation file system. Once the all the file metadata is loaded onto the volume, you can mount the volume with read-only access. during this process.

• VOLUME_INITIALIZE_WITH_SNAPSHOT - A volume is being created from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API (CreateVolume), or CLI (create-volume) when using the using the FULL_COPY strategy.

• VOLUME_UPDATE_WITH_SNAPSHOT - A volume is being updated from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API (CopySnapshotAndUpdateVolume), or CLI (copy-snapshot-and-update-volume).

Accessible with the following methods

Method	Description
GET_ADMINISTRATIVEACTIONTYPE()	Getter for ADMINISTRATIVEACTIONTYPE, with configurable defau
ASK_ADMINISTRATIVEACTIONTYPE()	Getter for ADMINISTRATIVEACTIONTYPE w/ exceptions if field h
HAS_ADMINISTRATIVEACTIONTYPE()	Determine if ADMINISTRATIVEACTIONTYPE has a value

ProgressPercent

The percentage-complete status of a STORAGE_OPTIMIZATION or DOWNLOAD_DATA_FROM_BACKUP administrative action. Does not apply to any other administrative action type.

Accessible with the following methods

Method	Description
GET_PROGRESSPERCENT()	Getter for PROGRESSPERCENT, with configurable default
ASK_PROGRESSPERCENT()	Getter for PROGRESSPERCENT w/ exceptions if field has no val
HAS_PROGRESSPERCENT()	Determine if PROGRESSPERCENT has a value

RequestTime

The time that the administrative action request was received.

Accessible with the following methods

Method	Description
GET_REQUESTTIME()	Getter for REQUESTTIME, with configurable default
ASK_REQUESTTIME()	Getter for REQUESTTIME w/ exceptions if field has no value
HAS_REQUESTTIME()	Determine if REQUESTTIME has a value

Status

The status of the administrative action, as follows:

• FAILED - Amazon FSx failed to process the administrative action successfully.

• IN_PROGRESS - Amazon FSx is processing the administrative action.

• PENDING - Amazon FSx is waiting to process the administrative action.

• COMPLETED - Amazon FSx has finished processing the administrative task.

  For a backup restore to a second-generation FSx for ONTAP file system, indicates that all data has been downloaded to the volume, and clients now have read-write access to volume.

• UPDATED_OPTIMIZING - For a storage-capacity increase update, Amazon FSx has updated the file system with the new storage capacity, and is now performing the storage-optimization process.

• PENDING - For a backup restore to a second-generation FSx for ONTAP file system, indicates that the file metadata is being downloaded onto the volume. The volume's Lifecycle state is CREATING.

• IN_PROGRESS - For a backup restore to a second-generation FSx for ONTAP file system, indicates that all metadata has been downloaded to the new volume and client can access data with read-only access while Amazon FSx downloads the file data to the volume. Track the progress of this process with the ProgressPercent element.

Accessible with the following methods

Method	Description
GET_STATUS()	Getter for STATUS, with configurable default
ASK_STATUS()	Getter for STATUS w/ exceptions if field has no value
HAS_STATUS()	Determine if STATUS has a value

TargetFileSystemValues

The target value for the administration action, provided in the UpdateFileSystem operation. Returned for FILE_SYSTEM_UPDATE administrative actions.

Accessible with the following methods

Method	Description
GET_TARGETFILESYSTEMVALUES()	Getter for TARGETFILESYSTEMVALUES

FailureDetails

Provides information about a failed administrative action.

Accessible with the following methods

Method	Description
GET_FAILUREDETAILS()	Getter for FAILUREDETAILS

TargetVolumeValues

Describes an Amazon FSx volume.

Accessible with the following methods

Method	Description
GET_TARGETVOLUMEVALUES()	Getter for TARGETVOLUMEVALUES

TargetSnapshotValues

A snapshot of an Amazon FSx for OpenZFS volume.

Accessible with the following methods

Method	Description
GET_TARGETSNAPSHOTVALUES()	Getter for TARGETSNAPSHOTVALUES

TotalTransferBytes

The number of bytes that have transferred for the FSx for OpenZFS snapshot that you're copying.

Accessible with the following methods

Method	Description
GET_TOTALTRANSFERBYTES()	Getter for TOTALTRANSFERBYTES, with configurable default
ASK_TOTALTRANSFERBYTES()	Getter for TOTALTRANSFERBYTES w/ exceptions if field has no
HAS_TOTALTRANSFERBYTES()	Determine if TOTALTRANSFERBYTES has a value

RemainingTransferBytes

The remaining bytes to transfer for the FSx for OpenZFS snapshot that you're copying.

Accessible with the following methods

Method	Description
GET_REMAININGTRANSFERBYTES()	Getter for REMAININGTRANSFERBYTES, with configurable default
ASK_REMAININGTRANSFERBYTES()	Getter for REMAININGTRANSFERBYTES w/ exceptions if field has
HAS_REMAININGTRANSFERBYTES()	Determine if REMAININGTRANSFERBYTES has a value

Message

A detailed error message.

Accessible with the following methods

Method	Description
GET_MESSAGE()	Getter for MESSAGE, with configurable default
ASK_MESSAGE()	Getter for MESSAGE w/ exceptions if field has no value
HAS_MESSAGE()	Determine if MESSAGE has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_ADMINISTRATIVEACTIONS

TYPES TT_ADMINISTRATIVEACTIONS TYPE STANDARD TABLE OF REF TO /AWS1/CL_FSXADMINISTRATIVEACT WITH DEFAULT KEY
.