UpdateLocationFsxOntapCommand

Suggest an Edit

Modifies the following configuration parameters of the Amazon FSx for NetApp ONTAP transfer location that you're using with DataSync.

For more information, see Configuring DataSync transfers with FSx for ONTAP .

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DataSyncClient, UpdateLocationFsxOntapCommand } from "@aws-sdk/client-datasync"; // ES Modules import
// const { DataSyncClient, UpdateLocationFsxOntapCommand } = require("@aws-sdk/client-datasync"); // CommonJS import
const client = new DataSyncClient(config);
const input = { // UpdateLocationFsxOntapRequest
  LocationArn: "STRING_VALUE", // required
  Protocol: { // FsxUpdateProtocol
    NFS: { // FsxProtocolNfs
      MountOptions: { // NfsMountOptions
        Version: "AUTOMATIC" || "NFS3" || "NFS4_0" || "NFS4_1",
      },
    },
    SMB: { // FsxUpdateProtocolSmb
      Domain: "STRING_VALUE",
      MountOptions: { // SmbMountOptions
        Version: "AUTOMATIC" || "SMB2" || "SMB3" || "SMB1" || "SMB2_0",
      },
      Password: "STRING_VALUE",
      User: "STRING_VALUE",
    },
  },
  Subdirectory: "STRING_VALUE",
};
const command = new UpdateLocationFsxOntapCommand(input);
const response = await client.send(command);
// {};

UpdateLocationFsxOntapCommand Input

See UpdateLocationFsxOntapCommandInput for more details

Parameter
Type
Description
LocationArn
Required
string | undefined

Specifies the Amazon Resource Name (ARN) of the FSx for ONTAP transfer location that you're updating.

Protocol
FsxUpdateProtocol | undefined

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

Subdirectory
string | undefined

Specifies a path to the file share in the storage virtual machine (SVM) where you want to transfer data to or from.

You can specify a junction path (also known as a mount point), qtree path (for NFS file shares), or share name (for SMB file shares). For example, your mount path might be /vol1, /vol1/tree1, or /share1.

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.

UpdateLocationFsxOntapCommand Output

See UpdateLocationFsxOntapCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

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.