create-location-fsx-ontap¶

Description¶

Creates an endpoint for an Amazon FSx for NetApp ONTAP file system that DataSync can access for a transfer. For more information, see Creating a location for FSx for ONTAP .

Synopsis¶

  create-location-fsx-ontap
--protocol <value>
--security-group-arns <value>
--storage-virtual-machine-arn <value>
[--subdirectory <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--protocol (structure)

Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system.

NFS -> (structure)

Specifies the Network File System (NFS) protocol configuration that DataSync uses to access your FSx for OpenZFS file system or FSx for ONTAP file system’s storage virtual machine (SVM).

MountOptions -> (structure)

Specifies how DataSync can access a location using the NFS protocol.

Version -> (string)

Specifies the NFS version that you want DataSync to use when mounting your NFS share. If the server refuses to use the version specified, the task fails.

You can specify the following options:

AUTOMATIC (default): DataSync chooses NFS version 4.1.

NFS3 : Stateless protocol version that allows for asynchronous writes on the server.

NFSv4_0 : Stateful, firewall-friendly protocol version that supports delegations and pseudo file systems.

NFSv4_1 : Stateful protocol version that supports sessions, directory delegations, and parallel data processing. NFS version 4.1 also includes all features available in version 4.0.

Note

DataSync currently only supports NFS version 3 with Amazon FSx for NetApp ONTAP locations.

SMB -> (structure)

Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your FSx for ONTAP file system’s SVM.

Domain -> (string)

Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that your storage virtual machine (SVM) belongs to.

MountOptions -> (structure)

Specifies how DataSync can access a location using the SMB protocol.

Version -> (string)

Specifies the SMB version that you want DataSync to use when mounting your SMB share. If you don’t specify a version, DataSync defaults to AUTOMATIC and chooses a version based on negotiation with the SMB server.

Password -> (string)

Specifies the password of a user who has permission to access your SVM.

User -> (string)

Specifies a user who has permission to access your SVM.

Shorthand Syntax:

NFS={MountOptions={Version=string}},SMB={Domain=string,MountOptions={Version=string},Password=string,User=string}

JSON Syntax:

{
  "NFS": {
    "MountOptions": {
      "Version": "AUTOMATIC"|"NFS3"|"NFS4_0"|"NFS4_1"
    }
  },
  "SMB": {
    "Domain": "string",
    "MountOptions": {
      "Version": "AUTOMATIC"|"SMB2"|"SMB3"
    },
    "Password": "string",
    "User": "string"
  }
}

--security-group-arns (list)

Specifies the security groups that DataSync can use to access your FSx for ONTAP file system. You must configure the security groups to allow outbound traffic on the following ports (depending on the protocol that you’re using):

Network File System (NFS) : TCP port 2049

Server Message Block (SMB) : TCP port 445

Your file system’s security groups must also allow inbound traffic on the same port.

(string)

Syntax:

"string" "string" ...

--storage-virtual-machine-arn (string)

Specifies the ARN of the storage virtual machine (SVM) on your file system where you’re copying data to or from.

--subdirectory (string)

Specifies the junction path (also known as a mount point) in the SVM volume where you’re copying data to or from (for example, /vol1 ).

Note

Don’t specify a junction path in the SVM’s root volume. For more information, see Managing FSx for ONTAP storage virtual machines in the Amazon FSx for NetApp ONTAP User Guide .

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

(structure)

Represents a single entry in a list of Amazon Web Services resource tags. TagListEntry returns an array that contains a list of tasks when the ListTagsForResource operation is called.

Key -> (string)

The key for an Amazon Web Services resource tag.

Value -> (string)

The value for an Amazon Web Services resource tag.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output¶

LocationArn -> (string)

Specifies the ARN of the FSx for ONTAP file system location that you create.

Table of Contents

Feedback

User Guide