- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
AddStorageSystemCommand
Creates an Amazon Web Services resource for an on-premises storage system that you want DataSync Discovery to collect information about.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { DataSyncClient, AddStorageSystemCommand } from "@aws-sdk/client-datasync"; // ES Modules import
// const { DataSyncClient, AddStorageSystemCommand } = require("@aws-sdk/client-datasync"); // CommonJS import
const client = new DataSyncClient(config);
const input = { // AddStorageSystemRequest
ServerConfiguration: { // DiscoveryServerConfiguration
ServerHostname: "STRING_VALUE", // required
ServerPort: Number("int"),
},
SystemType: "NetAppONTAP", // required
AgentArns: [ // DiscoveryAgentArnList // required
"STRING_VALUE",
],
CloudWatchLogGroupArn: "STRING_VALUE",
Tags: [ // InputTagList
{ // TagListEntry
Key: "STRING_VALUE", // required
Value: "STRING_VALUE",
},
],
Name: "STRING_VALUE",
ClientToken: "STRING_VALUE", // required
Credentials: { // Credentials
Username: "STRING_VALUE", // required
Password: "STRING_VALUE", // required
},
};
const command = new AddStorageSystemCommand(input);
const response = await client.send(command);
// { // AddStorageSystemResponse
// StorageSystemArn: "STRING_VALUE", // required
// };
AddStorageSystemCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
AgentArns Required | string[] | undefined | Specifies the Amazon Resource Name (ARN) of the DataSync agent that connects to and reads from your on-premises storage system's management interface. You can only specify one ARN. |
Credentials Required | Credentials | undefined | Specifies the user name and password for accessing your on-premises storage system's management interface. |
ServerConfiguration Required | DiscoveryServerConfiguration | undefined | Specifies the server name and network port required to connect with the management interface of your on-premises storage system. |
SystemType Required | DiscoverySystemType | undefined | Specifies the type of on-premises storage system that you want DataSync Discovery to collect information about. DataSync Discovery currently supports NetApp Fabric-Attached Storage (FAS) and All Flash FAS (AFF) systems running ONTAP 9.7 or later. |
ClientToken | string | undefined | Specifies a client token to make sure requests with this API operation are idempotent. If you don't specify a client token, DataSync generates one for you automatically. |
CloudWatchLogGroupArn | string | undefined | Specifies the ARN of the Amazon CloudWatch log group for monitoring and logging discovery job events. |
Name | string | undefined | Specifies a familiar name for your on-premises storage system. |
Tags | TagListEntry[] | undefined | Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your on-premises storage system. |
AddStorageSystemCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
StorageSystemArn Required | string | undefined | The ARN of the on-premises storage system that you can use with DataSync Discovery. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
InternalException | server | This exception is thrown when an error occurs in the DataSync service. |
InvalidRequestException | client | This exception is thrown when the client submits a malformed request. |
DataSyncServiceException | Base exception class for all service exceptions from DataSync service. |