Cmdlets for XML

Build 23.0.8839

Connecting to SFTP

Connecting to SFTP

You can authenticate to SFTP using a user and password or an SSH certificate. Additionally, you can connect to an SFTP server that has no authentication enabled.

No Authentication

Set SSHAuthMode to None to connect without authentication, assuming your server supports doing so.

Password

Provide user credentials associated with your SFTP server:

  • SSHAuthMode: Set this to Password.
  • SSHUser: A username associated with your SFTP server.
  • SSHPassword: The password associated with the user.

SSH Certificate

Set the following to connect.

  • SSHAuthMode: Set this to Public_Key.
  • SSHClientCert: Specify the SSH certificate in the form specified by SSHClientCertType (see the associated documentation for this connection property).
  • SSHClientCertType: The type of the key store specified in SSHClientCert.
  • SSHClientCertPassword (optional): The certificate store password.
  • SSHClientCertSubject (optional): If there are multiple keys in your key store, specify the desired key, by name, here.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839