Class: Aws::FSx::Types::AdministrativeAction
- Inherits:
-
Struct
- Object
- Struct
- Aws::FSx::Types::AdministrativeAction
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-fsx/types.rb
Overview
Describes a specific Amazon FSx administrative action for the current Windows, Lustre, or OpenZFS file system.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#administrative_action_type ⇒ String
Describes the type of administrative action, as follows:.
-
#failure_details ⇒ Types::AdministrativeActionFailureDetails
Provides information about a failed administrative action.
-
#progress_percent ⇒ Integer
The percentage-complete status of a ‘STORAGE_OPTIMIZATION` administrative action.
-
#request_time ⇒ Time
The time that the administrative action request was received.
-
#status ⇒ String
Describes the status of the administrative action, as follows:.
-
#target_file_system_values ⇒ Types::FileSystem
Describes the target value for the administration action, provided in the ‘UpdateFileSystem` operation.
-
#target_snapshot_values ⇒ Types::Snapshot
A snapshot of an Amazon FSx for OpenZFS volume.
-
#target_volume_values ⇒ Types::Volume
Describes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.
Instance Attribute Details
#administrative_action_type ⇒ String
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`).
-
‘STORAGE_OPTIMIZATION` - After the `FILE_SYSTEM_UPDATE` task to increase a file system’s storage capacity has been 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 and throughput 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].
-
‘VOLUME_UPDATE` - A volume update to an Amazon FSx for NetApp ONTAP or 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.
[1]: docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-storage-capacity.html [2]: docs.aws.amazon.com/fsx/latest/LustreGuide/managing-storage-capacity.html [3]: docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-storage-capacity.html [4]: docs.aws.amazon.com/fsx/latest/APIReference/API_AssociateFileSystemAliases.html [5]: docs.aws.amazon.com/fsx/latest/APIReference/API_DisassociateFileSystemAliases.html
187 188 189 190 191 192 193 194 195 196 197 198 |
# File 'lib/aws-sdk-fsx/types.rb', line 187 class AdministrativeAction < Struct.new( :administrative_action_type, :progress_percent, :request_time, :status, :target_file_system_values, :failure_details, :target_volume_values, :target_snapshot_values) SENSITIVE = [] include Aws::Structure end |
#failure_details ⇒ Types::AdministrativeActionFailureDetails
Provides information about a failed administrative action.
187 188 189 190 191 192 193 194 195 196 197 198 |
# File 'lib/aws-sdk-fsx/types.rb', line 187 class AdministrativeAction < Struct.new( :administrative_action_type, :progress_percent, :request_time, :status, :target_file_system_values, :failure_details, :target_volume_values, :target_snapshot_values) SENSITIVE = [] include Aws::Structure end |
#progress_percent ⇒ Integer
The percentage-complete status of a ‘STORAGE_OPTIMIZATION` administrative action. Does not apply to any other administrative action type.
187 188 189 190 191 192 193 194 195 196 197 198 |
# File 'lib/aws-sdk-fsx/types.rb', line 187 class AdministrativeAction < Struct.new( :administrative_action_type, :progress_percent, :request_time, :status, :target_file_system_values, :failure_details, :target_volume_values, :target_snapshot_values) SENSITIVE = [] include Aws::Structure end |
#request_time ⇒ Time
The time that the administrative action request was received.
187 188 189 190 191 192 193 194 195 196 197 198 |
# File 'lib/aws-sdk-fsx/types.rb', line 187 class AdministrativeAction < Struct.new( :administrative_action_type, :progress_percent, :request_time, :status, :target_file_system_values, :failure_details, :target_volume_values, :target_snapshot_values) SENSITIVE = [] include Aws::Structure end |
#status ⇒ String
Describes 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.
-
‘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.
187 188 189 190 191 192 193 194 195 196 197 198 |
# File 'lib/aws-sdk-fsx/types.rb', line 187 class AdministrativeAction < Struct.new( :administrative_action_type, :progress_percent, :request_time, :status, :target_file_system_values, :failure_details, :target_volume_values, :target_snapshot_values) SENSITIVE = [] include Aws::Structure end |
#target_file_system_values ⇒ Types::FileSystem
Describes the target value for the administration action, provided in the ‘UpdateFileSystem` operation. Returned for `FILE_SYSTEM_UPDATE` administrative actions.
187 188 189 190 191 192 193 194 195 196 197 198 |
# File 'lib/aws-sdk-fsx/types.rb', line 187 class AdministrativeAction < Struct.new( :administrative_action_type, :progress_percent, :request_time, :status, :target_file_system_values, :failure_details, :target_volume_values, :target_snapshot_values) SENSITIVE = [] include Aws::Structure end |
#target_snapshot_values ⇒ Types::Snapshot
A snapshot of an Amazon FSx for OpenZFS volume.
187 188 189 190 191 192 193 194 195 196 197 198 |
# File 'lib/aws-sdk-fsx/types.rb', line 187 class AdministrativeAction < Struct.new( :administrative_action_type, :progress_percent, :request_time, :status, :target_file_system_values, :failure_details, :target_volume_values, :target_snapshot_values) SENSITIVE = [] include Aws::Structure end |
#target_volume_values ⇒ Types::Volume
Describes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.
187 188 189 190 191 192 193 194 195 196 197 198 |
# File 'lib/aws-sdk-fsx/types.rb', line 187 class AdministrativeAction < Struct.new( :administrative_action_type, :progress_percent, :request_time, :status, :target_file_system_values, :failure_details, :target_volume_values, :target_snapshot_values) SENSITIVE = [] include Aws::Structure end |