[ aws . datasync ]

describe-location-fsx-ontap

Description

Provides details about how an DataSync location for an Amazon FSx for NetApp ONTAP file system is configured.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-location-fsx-ontap
--location-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--location-arn (string)

Specifies the Amazon Resource Name (ARN) of the FSx for ONTAP file system location that you want information about.

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

CreationTime -> (timestamp)

The time that the location was created.

LocationArn -> (string)

The ARN of the FSx for ONTAP file system location.

LocationUri -> (string)

The uniform resource identifier (URI) of the FSx for ONTAP file system location.

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 name that can mount the location and access the files, folders, and metadata that you need in the SVM.

If you provide a user in your Active Directory, note the following:

• If you’re using Directory Service for Microsoft Active Directory, the user must be a member of the Amazon Web Services Delegated FSx Administrators group.

• If you’re using a self-managed Active Directory, the user must be a member of either the Domain Admins group or a custom group that you specified for file system administration when you created your file system.

Make sure that the user has the permissions it needs to copy the data you want:

• SE_TCB_NAME : Required to set object ownership and file metadata. With this privilege, you also can copy NTFS discretionary access lists (DACLs).

• SE_SECURITY_NAME : May be needed to copy NTFS system access control lists (SACLs). This operation specifically requires the Windows privilege, which is granted to members of the Domain Admins group. If you configure your task to copy SACLs, make sure that the user has the required privileges. For information about copying SACLs, see Ownership and permissions-related options .

SecurityGroupArns -> (list)

The security groups that DataSync uses to access your FSx for ONTAP file system.

(string)

StorageVirtualMachineArn -> (string)

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

FsxFilesystemArn -> (string)

The ARN of the FSx for ONTAP file system.