Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . datasync ]

describe-storage-system-resources

Description

Returns information that DataSync Discovery collects about resources in your on-premises storage system.

See also: AWS API Documentation

Synopsis

  describe-storage-system-resources
--discovery-job-arn <value>
--resource-type <value>
[--resource-ids <value>]
[--filter <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--discovery-job-arn (string)

Specifies the Amazon Resource Name (ARN) of the discovery job that's collecting data from your on-premises storage system.

--resource-type (string)

Specifies what kind of storage system resources that you want information about.

Possible values:

• SVM
• VOLUME
• CLUSTER

--resource-ids (list)

Specifies the universally unique identifiers (UUIDs) of the storage system resources that you want information about. You can't use this parameter in combination with the Filter parameter.

(string)

Syntax:

"string" "string" ...

--filter (map)

Filters the storage system resources that you want returned. For example, this might be volumes associated with a specific storage virtual machine (SVM).

key -> (string)

value -> (list)

(string)

Shorthand Syntax:

  KeyName1=string,string,KeyName2=string,string

Where valid key names are:
  SVM

JSON Syntax:

{"SVM": ["string", ...]
  ...}

--max-results (integer)

Specifies the maximum number of storage system resources that you want to list in a response.

--next-token (string)

Specifies an opaque string that indicates the position to begin the next list of results in the response.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

ResourceDetails -> (structure)

The information collected about your storage system's resources. A response can also include Amazon Web Services storage service recommendations.

For more information, see storage resource information collected by and recommendations provided by DataSync Discovery.

NetAppONTAPSVMs -> (list)

The information that DataSync Discovery collects about storage virtual machines (SVMs) in your on-premises storage system.

(structure)

The information that DataSync Discovery collects about a storage virtual machine (SVM) in your on-premises storage system.

ClusterUuid -> (string)

The universally unique identifier (UUID) of the cluster associated with the SVM.

ResourceId -> (string)

The UUID of the SVM.

SvmName -> (string)

The name of the SVM

CifsShareCount -> (long)

The number of CIFS shares in the SVM.

EnabledProtocols -> (list)

The data transfer protocols (such as NFS) configured for the SVM.

(string)

TotalCapacityUsed -> (long)

The storage space that's being used in the SVM.

TotalCapacityProvisioned -> (long)

The total storage space that's available in the SVM.

TotalLogicalCapacityUsed -> (long)

The storage space that's being used in the SVM without accounting for compression or deduplication.

MaxP95Performance -> (structure)

The performance data that DataSync Discovery collects about the SVM.

IopsRead -> (double)

Peak IOPS related to read operations.

IopsWrite -> (double)

Peak IOPS related to write operations.

IopsOther -> (double)

Peak IOPS unrelated to read and write operations.

IopsTotal -> (double)

Peak total IOPS on your on-premises storage system resource.

ThroughputRead -> (double)

Peak throughput related to read operations.

ThroughputWrite -> (double)

Peak throughput related to write operations.

ThroughputOther -> (double)

Peak throughput unrelated to read and write operations.

ThroughputTotal -> (double)

Peak total throughput on your on-premises storage system resource.

LatencyRead -> (double)

Peak latency for read operations.

LatencyWrite -> (double)

Peak latency for write operations.

LatencyOther -> (double)

Peak latency for operations unrelated to read and write operations.

Recommendations -> (list)

The Amazon Web Services storage services that DataSync Discovery recommends for the SVM. For more information, see Recommendations provided by DataSync Discovery .

(structure)

The details about an Amazon Web Services storage service that DataSync Discovery recommends for a resource in your on-premises storage system.

For more information, see Recommendations provided by DataSync Discovery .

StorageType -> (string)

A recommended Amazon Web Services storage service that you can migrate data to based on information that DataSync Discovery collects about your on-premises storage system.

StorageConfiguration -> (map)

Information about how you can set up a recommended Amazon Web Services storage service.

key -> (string)

value -> (string)

EstimatedMonthlyStorageCost -> (string)

The estimated monthly cost of the recommended Amazon Web Services storage service.

NfsExportedVolumes -> (long)

The number of NFS volumes in the SVM.

RecommendationStatus -> (string)

Indicates whether DataSync Discovery recommendations for the SVM are ready to view, incomplete, or can't be determined.

For more information, see Recommendation statuses .

TotalSnapshotCapacityUsed -> (long)

The amount of storage in the SVM that's being used for snapshots.

LunCount -> (long)

The number of LUNs (logical unit numbers) in the SVM.

NetAppONTAPVolumes -> (list)

The information that DataSync Discovery collects about volumes in your on-premises storage system.

(structure)

The information that DataSync Discovery collects about a volume in your on-premises storage system.

VolumeName -> (string)

The name of the volume.

ResourceId -> (string)

The universally unique identifier (UUID) of the volume.

CifsShareCount -> (long)

The number of CIFS shares in the volume.

SecurityStyle -> (string)

The volume's security style (such as Unix or NTFS).

SvmUuid -> (string)

The UUID of the storage virtual machine (SVM) associated with the volume.

SvmName -> (string)

The name of the SVM associated with the volume.

CapacityUsed -> (long)

The storage space that's being used in the volume.

CapacityProvisioned -> (long)

The total storage space that's available in the volume.

LogicalCapacityUsed -> (long)

The storage space that's being used in the volume without accounting for compression or deduplication.

NfsExported -> (boolean)

The number of NFS volumes in the volume.

SnapshotCapacityUsed -> (long)

The amount of storage in the volume that's being used for snapshots.

MaxP95Performance -> (structure)

The performance data that DataSync Discovery collects about the volume.

IopsRead -> (double)

Peak IOPS related to read operations.

IopsWrite -> (double)

Peak IOPS related to write operations.

IopsOther -> (double)

Peak IOPS unrelated to read and write operations.

IopsTotal -> (double)

Peak total IOPS on your on-premises storage system resource.

ThroughputRead -> (double)

Peak throughput related to read operations.

ThroughputWrite -> (double)

Peak throughput related to write operations.

ThroughputOther -> (double)

Peak throughput unrelated to read and write operations.

ThroughputTotal -> (double)

Peak total throughput on your on-premises storage system resource.

LatencyRead -> (double)

Peak latency for read operations.

LatencyWrite -> (double)

Peak latency for write operations.

LatencyOther -> (double)

Peak latency for operations unrelated to read and write operations.

Recommendations -> (list)

The Amazon Web Services storage services that DataSync Discovery recommends for the volume. For more information, see Recommendations provided by DataSync Discovery .

(structure)

The details about an Amazon Web Services storage service that DataSync Discovery recommends for a resource in your on-premises storage system.

For more information, see Recommendations provided by DataSync Discovery .

StorageType -> (string)

A recommended Amazon Web Services storage service that you can migrate data to based on information that DataSync Discovery collects about your on-premises storage system.

StorageConfiguration -> (map)

Information about how you can set up a recommended Amazon Web Services storage service.

key -> (string)

value -> (string)

EstimatedMonthlyStorageCost -> (string)

The estimated monthly cost of the recommended Amazon Web Services storage service.

RecommendationStatus -> (string)

Indicates whether DataSync Discovery recommendations for the volume are ready to view, incomplete, or can't be determined.

For more information, see Recommendation statuses .

LunCount -> (long)

The number of LUNs (logical unit numbers) in the volume.

NetAppONTAPClusters -> (list)

The information that DataSync Discovery collects about the cluster in your on-premises storage system.

(structure)

The information that DataSync Discovery collects about an on-premises storage system cluster.

CifsShareCount -> (long)

The number of CIFS shares in the cluster.

NfsExportedVolumes -> (long)

The number of NFS volumes in the cluster.

ResourceId -> (string)

The universally unique identifier (UUID) of the cluster.

ClusterName -> (string)

The name of the cluster.

MaxP95Performance -> (structure)

The performance data that DataSync Discovery collects about the cluster.

IopsRead -> (double)

Peak IOPS related to read operations.

IopsWrite -> (double)

Peak IOPS related to write operations.

IopsOther -> (double)

Peak IOPS unrelated to read and write operations.

IopsTotal -> (double)

Peak total IOPS on your on-premises storage system resource.

ThroughputRead -> (double)

Peak throughput related to read operations.

ThroughputWrite -> (double)

Peak throughput related to write operations.

ThroughputOther -> (double)

Peak throughput unrelated to read and write operations.

ThroughputTotal -> (double)

Peak total throughput on your on-premises storage system resource.

LatencyRead -> (double)

Peak latency for read operations.

LatencyWrite -> (double)

Peak latency for write operations.

LatencyOther -> (double)

Peak latency for operations unrelated to read and write operations.

ClusterBlockStorageSize -> (long)

The total storage space that's available in the cluster.

ClusterBlockStorageUsed -> (long)

The storage space that's being used in a cluster.

ClusterBlockStorageLogicalUsed -> (long)

The storage space that's being used in the cluster without accounting for compression or deduplication.

Recommendations -> (list)

The Amazon Web Services storage services that DataSync Discovery recommends for the cluster. For more information, see Recommendations provided by DataSync Discovery .

(structure)

The details about an Amazon Web Services storage service that DataSync Discovery recommends for a resource in your on-premises storage system.

For more information, see Recommendations provided by DataSync Discovery .

StorageType -> (string)

A recommended Amazon Web Services storage service that you can migrate data to based on information that DataSync Discovery collects about your on-premises storage system.

StorageConfiguration -> (map)

Information about how you can set up a recommended Amazon Web Services storage service.

key -> (string)

value -> (string)

EstimatedMonthlyStorageCost -> (string)

The estimated monthly cost of the recommended Amazon Web Services storage service.

RecommendationStatus -> (string)

Indicates whether DataSync Discovery recommendations for the cluster are ready to view, incomplete, or can't be determined.

For more information, see Recommendation statuses .

LunCount -> (long)

The number of LUNs (logical unit numbers) in the cluster.

ClusterCloudStorageUsed -> (long)

The amount of space in the cluster that's in cloud storage (for example, if you're using data tiering).

NextToken -> (string)

The opaque string that indicates the position to begin the next list of results in the response.