DataSync / Client / add_storage_system

add_storage_system

DataSync.Client.add_storage_system(**kwargs)

Creates an Amazon Web Services resource for an on-premises storage system that you want DataSync Discovery to collect information about.

See also: AWS API Documentation

Request Syntax

response = client.add_storage_system(
    ServerConfiguration={
        'ServerHostname': 'string',
        'ServerPort': 123
    },
    SystemType='NetAppONTAP',
    AgentArns=[
        'string',
    ],
    CloudWatchLogGroupArn='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    Name='string',
    ClientToken='string',
    Credentials={
        'Username': 'string',
        'Password': 'string'
    }
)

Parameters:

• ServerConfiguration (dict) –

  [REQUIRED]

  Specifies the server name and network port required to connect with the management interface of your on-premises storage system.

  • ServerHostname (string) – [REQUIRED]

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

  [REQUIRED]

  Specifies the type of on-premises storage system that you want DataSync Discovery to collect information about.

  Note

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

• AgentArns (list) –

  [REQUIRED]

  Specifies the Amazon Resource Name (ARN) of the DataSync agent that connects to and reads from your on-premises storage system’s management interface.

  • (string) –

• CloudWatchLogGroupArn (string) – Specifies the ARN of the Amazon CloudWatch log group for monitoring and logging discovery job events.

• Tags (list) –

  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.

  • (dict) –

    A key-value pair representing a single tag that’s been applied to an Amazon Web Services resource.

    • Key (string) – [REQUIRED]

      The key for an Amazon Web Services resource tag.

    • Value (string) –

      The value for an Amazon Web Services resource tag.

• Name (string) – Specifies a familiar name for your on-premises storage system.

• ClientToken (string) –

  [REQUIRED]

  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.

  This field is autopopulated if not provided.

• Credentials (dict) –

  [REQUIRED]

  Specifies the user name and password for accessing your on-premises storage system’s management interface.

  • Username (string) – [REQUIRED]

    Specifies the user name for your storage system’s management interface.

  • Password (string) – [REQUIRED]

    Specifies the password for your storage system’s management interface.

Return type:

dict

Returns:

Response Syntax

{
    'StorageSystemArn': 'string'
}

Response Structure

• (dict) –

  • StorageSystemArn (string) –

    The ARN of the on-premises storage system that you can use with DataSync Discovery.

Exceptions

• DataSync.Client.exceptions.InvalidRequestException

• DataSync.Client.exceptions.InternalException