AWS CLI Command Reference

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

Description

Returns information about an on-premises storage system that you're using with DataSync Discovery.

See also: AWS API Documentation

Synopsis

  describe-storage-system
--storage-system-arn <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

--storage-system-arn (string)

Specifies the Amazon Resource Name (ARN) of an on-premises storage system that you're using with DataSync Discovery.

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

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

StorageSystemArn -> (string)

The ARN of the on-premises storage system that the discovery job looked at.

ServerConfiguration -> (structure)

The server name and network port required to connect with your on-premises storage system's management interface.

ServerHostname -> (string)

The domain name or IP address of your storage system's management interface.

ServerPort -> (integer)

The network port for accessing the storage system's management interface.

SystemType -> (string)

The type of on-premises storage system.

Note

DataSync Discovery currently only supports NetApp Fabric-Attached Storage (FAS) and All Flash FAS (AFF) systems running ONTAP 9.7 or later.

AgentArns -> (list)

The ARN of the DataSync agent that connects to and reads from your on-premises storage system.

(string)

Name -> (string)

The name that you gave your on-premises storage system when adding it to DataSync Discovery.

ErrorMessage -> (string)

Describes the connectivity error that the DataSync agent is encountering with your on-premises storage system.

ConnectivityStatus -> (string)

Indicates whether your DataSync agent can connect to your on-premises storage system.

CloudWatchLogGroupArn -> (string)

The ARN of the Amazon CloudWatch log group that's used to monitor and log discovery job events.

CreationTime -> (timestamp)

The time when you added the on-premises storage system to DataSync Discovery.

SecretsManagerArn -> (string)

The ARN of the secret that stores your on-premises storage system's credentials. DataSync Discovery stores these credentials in Secrets Manager .