Class: Aws::FSx::Types::AdministrativeAction

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-fsx/types.rb

Overview

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

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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`).

  • ‘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][1

    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`).

[1]: docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-throughput-capacity.html [2]: docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-storage-capacity.html [3]: docs.aws.amazon.com/fsx/latest/LustreGuide/managing-storage-capacity.html [4]: docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-storage-capacity.html [5]: docs.aws.amazon.com/fsx/latest/APIReference/API_AssociateFileSystemAliases.html [6]: docs.aws.amazon.com/fsx/latest/APIReference/API_DisassociateFileSystemAliases.html [7]: docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-provisioned-ssd-iops.html

Returns:

  • (String) 


261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/aws-sdk-fsx/types.rb', line 261

class AdministrativeAction < Struct.new(
  :administrative_action_type,
  :progress_percent,
  :request_time,
  :status,
  :target_file_system_values,
  :failure_details,
  :target_volume_values,
  :target_snapshot_values,
  :total_transfer_bytes,
  :remaining_transfer_bytes)
  SENSITIVE = []
  include Aws::Structure
end

#failure_details ⇒ Types::AdministrativeActionFailureDetails

Provides information about a failed administrative action.

Returns:



261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/aws-sdk-fsx/types.rb', line 261

class AdministrativeAction < Struct.new(
  :administrative_action_type,
  :progress_percent,
  :request_time,
  :status,
  :target_file_system_values,
  :failure_details,
  :target_volume_values,
  :target_snapshot_values,
  :total_transfer_bytes,
  :remaining_transfer_bytes)
  SENSITIVE = []
  include Aws::Structure
end

#progress_percent ⇒ Integer

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

Returns:

  • (Integer) 


261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/aws-sdk-fsx/types.rb', line 261

class AdministrativeAction < Struct.new(
  :administrative_action_type,
  :progress_percent,
  :request_time,
  :status,
  :target_file_system_values,
  :failure_details,
  :target_volume_values,
  :target_snapshot_values,
  :total_transfer_bytes,
  :remaining_transfer_bytes)
  SENSITIVE = []
  include Aws::Structure
end

#remaining_transfer_bytes ⇒ Integer

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

Returns:

  • (Integer) 


261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/aws-sdk-fsx/types.rb', line 261

class AdministrativeAction < Struct.new(
  :administrative_action_type,
  :progress_percent,
  :request_time,
  :status,
  :target_file_system_values,
  :failure_details,
  :target_volume_values,
  :target_snapshot_values,
  :total_transfer_bytes,
  :remaining_transfer_bytes)
  SENSITIVE = []
  include Aws::Structure
end

#request_time ⇒ Time

The time that the administrative action request was received.

Returns:

  • (Time) 


261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/aws-sdk-fsx/types.rb', line 261

class AdministrativeAction < Struct.new(
  :administrative_action_type,
  :progress_percent,
  :request_time,
  :status,
  :target_file_system_values,
  :failure_details,
  :target_volume_values,
  :target_snapshot_values,
  :total_transfer_bytes,
  :remaining_transfer_bytes)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

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.

Returns:

  • (String) 


261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/aws-sdk-fsx/types.rb', line 261

class AdministrativeAction < Struct.new(
  :administrative_action_type,
  :progress_percent,
  :request_time,
  :status,
  :target_file_system_values,
  :failure_details,
  :target_volume_values,
  :target_snapshot_values,
  :total_transfer_bytes,
  :remaining_transfer_bytes)
  SENSITIVE = []
  include Aws::Structure
end

#target_file_system_values ⇒ Types::FileSystem

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

Returns:



261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/aws-sdk-fsx/types.rb', line 261

class AdministrativeAction < Struct.new(
  :administrative_action_type,
  :progress_percent,
  :request_time,
  :status,
  :target_file_system_values,
  :failure_details,
  :target_volume_values,
  :target_snapshot_values,
  :total_transfer_bytes,
  :remaining_transfer_bytes)
  SENSITIVE = []
  include Aws::Structure
end

#target_snapshot_values ⇒ Types::Snapshot

A snapshot of an Amazon FSx for OpenZFS volume.

Returns:



261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/aws-sdk-fsx/types.rb', line 261

class AdministrativeAction < Struct.new(
  :administrative_action_type,
  :progress_percent,
  :request_time,
  :status,
  :target_file_system_values,
  :failure_details,
  :target_volume_values,
  :target_snapshot_values,
  :total_transfer_bytes,
  :remaining_transfer_bytes)
  SENSITIVE = []
  include Aws::Structure
end

#target_volume_values ⇒ Types::Volume

Describes an Amazon FSx volume.

Returns:



261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/aws-sdk-fsx/types.rb', line 261

class AdministrativeAction < Struct.new(
  :administrative_action_type,
  :progress_percent,
  :request_time,
  :status,
  :target_file_system_values,
  :failure_details,
  :target_volume_values,
  :target_snapshot_values,
  :total_transfer_bytes,
  :remaining_transfer_bytes)
  SENSITIVE = []
  include Aws::Structure
end

#total_transfer_bytes ⇒ Integer

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

Returns:

  • (Integer) 


261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/aws-sdk-fsx/types.rb', line 261

class AdministrativeAction < Struct.new(
  :administrative_action_type,
  :progress_percent,
  :request_time,
  :status,
  :target_file_system_values,
  :failure_details,
  :target_volume_values,
  :target_snapshot_values,
  :total_transfer_bytes,
  :remaining_transfer_bytes)
  SENSITIVE = []
  include Aws::Structure
end