Parameters (Connect-SFTP Cmdlet)
The following is the full list of the parameters of the cmdlet with short descriptions. Click the links for further details.
| Property | Description |
| TableDepth | The depth level to display subfolders as views. |
| RemoteHost | Set this to the host name or address of the server. |
| RemotePath | The current path in the SFTP server. |
| User | 認証で使用されるSFTP ユーザーアカウント。 |
| Password | ユーザーの認証で使用されるパスワード。 |
| RemotePort | The port the SFTP server is running on. |
| Passive | Controls whether to direct the server into passive mode. Recommended if behind a firewall. |
| Property | Description |
| SSHAuthMode | The authentication method to be used to log on to an SFTP server. |
| SSHClientCert | SSHUser の認証に使用する証明書。 |
| SSHClientCertPassword | SSHClientCert キーのパスワード（ある場合）。 |
| SSHClientCertSubject | SSH クライアント証明書のサブジェクト。 |
| SSHClientCertType | SSHClientCert 秘密鍵の種類。 |
| SSHServerFingerprint | The SSH server fingerprint. |
| Property | Description |
| FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
| FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
| FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
| FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
| FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
| Property | Description |
| Logfile | ログファイルの名前と場所を指定するファイルパス。 |
| Verbosity | ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。 |
| LogModules | ログファイルに含めるコアモジュール。 |
| MaxLogFileSize | ログファイルの最大バイトサイズ（例えば、10MB）を指定する文字列。 |
| MaxLogFileCount | ログファイルの最大ファイル数を指定する文字列。 |
| Property | Description |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
| BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
| Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
| Property | Description |
| AutoCache | SELECT クエリの結果を、 CacheLocation 、または CacheConnection と CacheProvider の両方で指定されたキャッシュデータベースに自動的にキャッシュします。 |
| CacheLocation | キャッシュデータベースへのパスとファイル名を指定します。 |
| CacheTolerance | AutoCache 使用時のキャッシュ内の失効データに対する許容範囲の秒数。 |
| Offline | オフラインモードを使用して、ライブソースではなくキャッシュからデータを取得します。 |
| CacheMetadata | このプロパティは、テーブルメタデータをファイルストアにキャッシュするかどうかを決定します。 |
| Property | Description |
| FileRetrievalDepth | Specify the depth level of folders you want to query from the Root table. |
| IncludeHiddenFiles | whether or not hidden files should be fetched from the SFTP Server. |
| MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
| Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
| PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
| Readonly | このプロパティを使用して、provider からSFTP へのアクセスを読み取り専用に設定できます。 |
| RTK | ライセンス供与で使用されるランタイムキー。 |
| Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
| UseMLSD | Uses listings for machine processing. Used only for FTP servers. |
| UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
| UseSimpleNames | テーブルとカラムに簡略名を使用するかどうかを決定するboolean。 |