AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS DataSync UpdateLocationFsxOntap API operation.

Syntax

Update-DSYNLocationFsxOntap
-LocationArn <String>
-SMB_Domain <String>
-SMB_Password <String>
-Subdirectory <String>
-SMB_User <String>
-Protocol_NFS_MountOptions_Version <NfsVersion>
-Protocol_SMB_MountOptions_Version <SmbVersion>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonDataSyncConfig>

Description

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.

Parameters

-ClientConfig <AmazonDataSyncConfig>
Amazon.PowerShell.Cmdlets.DSYN.AmazonDataSyncClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LocationArn <String>
Specifies the Amazon Resource Name (ARN) of the FSx for ONTAP transfer location that you're updating.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the LocationArn parameter. The -PassThru parameter is deprecated, use -Select '^LocationArn' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Protocol_NFS_MountOptions_Version <NfsVersion>
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.
DataSync currently only supports NFS version 3 with Amazon FSx for NetApp ONTAP locations.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Protocol_SMB_MountOptions_Version <SmbVersion>
By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB file server. You also can configure DataSync to use a specific SMB version, but we recommend doing this only if DataSync has trouble negotiating with the SMB file server automatically.These are the following options for configuring the SMB version:
  • AUTOMATIC (default): DataSync and the SMB file server negotiate the highest version of SMB that they mutually support between 2.1 and 3.1.1.This is the recommended option. If you instead choose a specific version that your file server doesn't support, you may get an Operation Not Supported error.
  • SMB3: Restricts the protocol negotiation to only SMB version 3.0.2.
  • SMB2: Restricts the protocol negotiation to only SMB version 2.1.
  • SMB2_0: Restricts the protocol negotiation to only SMB version 2.0.
  • SMB1: Restricts the protocol negotiation to only SMB version 1.0.The SMB1 option isn't available when creating an Amazon FSx for NetApp ONTAP location.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DataSync.Model.UpdateLocationFsxOntapResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SMB_Domain <String>
Specifies the name of the Windows domain that your storage virtual machine (SVM) belongs to.If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right SVM.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProtocol_SMB_Domain
-SMB_Password <String>
Specifies the password of a user who has permission to access your SVM.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProtocol_SMB_Password
-SMB_User <String>
Specifies a user that can mount and access the files, folders, and metadata in your SVM.For information about choosing a user with the right level of access for your transfer, see Using the SMB protocol.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProtocol_SMB_User
-Subdirectory <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

None or Amazon.DataSync.Model.UpdateLocationFsxOntapResponse
This cmdlet does not generate any output.The service response (type Amazon.DataSync.Model.UpdateLocationFsxOntapResponse) be returned by specifying '-Select *'.
Service API Reference
User Guide
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z