Cmdlets for SFTP

Build 25.0.9434

SSHAuthMode Parameter (Connect-SFTP Cmdlet)

Specifies the SSH authentication method that the provider uses when connecting to the SFTP server.

Syntax

Connect-SFTP -SSHAuthMode string

Possible Values

None, MultiFactor, Password, PublicKey

Data Type

cstr

Default Value

"Password"

Remarks

The following values are supported:

  • None: No authentication is performed. The cmdlet ignores User and connects as an anonymous user
  • MultiFactor: The cmdlet attempts a multistep authentication process using the credential properties you've supplied. It follows the server’s allowed authentication methods in order and continues until authentication succeeds or fails. If any step is rejected, the cmdlet throws an exception.
  • Password: The cmdlet authenticates using the values of User and Password.
  • PublicKey: The cmdlet authenticates using User and SSHClientCert. The certificate must contain a private key.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434