アドバンストサーバーアクセスのクライアントを使用する

すべてのアドバンストサーバーアクセスのクライアントコマンドは、次の構文を使用します。

sft [global options] command [command options] [arguments...]

グローバルオプション

次のオプションを任意のクライアントコマンドで使用できます。

  • -h, --help:ヘルプを表示します。
  • -v, --version:バージョンを表示します。
  • --config-file:代替の構成ファイルパスを指定します。
  • --account:指定されたアカウントを使用します。
  • --team:指定されたチームを使用します。
  • --instance:アドバンストサーバーアクセスのプラットフォームの指定インスタンスを使用します。

クライアントコマンド

sft config

クライアント構成オプションを取得して設定します。「クライアントを構成する」をご覧ください。

sft dash

ブラウザでチームのダッシュボードを開きます。

sft device-info

クライアントのデバイス情報をJSONとして表示します。

sft enroll

アドバンストサーバーアクセスのプラットフォームのクライアントインベントリに新しいクライアントを追加します。

sft fleet

フリートのクライアントを管理します。例えば、コマンドsft fleet enroll -- token-file <filename>を使用すると、指定されたファイルのトークンシークレットを用いて、クライアントをチームにサイレント登録できます。

オプション:

  • enroll --token-file <filename> 指定されたファイルに保存されたトークンシークレットを使用して、クライアントをサイレント登録します。
  • -hsft fleetのヘルプを表示します。

sft list-accounts

クライアントが使用するように構成されているアカウントのリストが表示されます。

オプション:

  • --columns デフォルト出力に表示する小文字の列名のコンマ区切りリスト。
  • -l, --selector フィルタリングするセレクター (ラベルクエリ)。「セレクター」をご覧ください。
  • --output [format], -o [format] 次のいずれかの出力形式:defaultjsondescribe

例:

sft list-accounts -o json

sft list-accounts --columns account,id

sft list-accounts -l account=teamname --columns id,username

sft list-servers

現在のチームで利用可能なサーバーのリストを表示します。

オプション:

  • --columns:デフォルトの出力形式にのみ使用される、小文字の列名のコンマ区切りリスト
  • -l, --selector:フィルタリングするセレクター (ラベルクエリ)。「セレクター」を参照。
  • --output [format], -o [format] 次のいずれかの出力形式:defaultjsondescribe

例:

sft list-servers -l os_type=windows

sft list-servers -l os_type=windows,project_name=Demo

sft list-servers -l os_type=windows --columns id,hostname

sft list-servers -l os_type=linux -o json

sft list-servers-rjson

現在のチームで利用可能なサーバーのリストをRJSON形式で表示します。この出力をファイルに保存して、動的フォルダーを作成するためにRoyal TSXで使用できます。「アドバンストサーバーアクセスでRoyal TSXを使用する」をご覧ください。

sft login

クライアントの現在のチームからログアウトした場合、新しいセッションを作成し、チームのIDプロバイダーを認証します。

アクティブで承認されたクライアントセッションにより、アドバンストサーバーアクセスのクライアントは、必要に応じてバックグラウンドで認証(資格)情報を要求できるようになります。

sft logout

現在のセッションからログアウトします。

sft proxycommand

OpenSSH ProxyCommandと共に使用して、ssh、scp、rsync、ftpなどでsftをトランスペアレントに使用できるようにします。

オプション:

  • --config sft ssh-configを優先して、使用されなくなりました。
  • --via, --bastion ターゲットへの接続に使用するSSH 要塞ホスト。

sft rdp

引数として渡されたターゲットにRDP を介して接続します。

オプション:

  • --via, --bastion ターゲットへの接続に使用するSSH 要塞ホスト。

sft resolve

指定されたホスト名またはインスタンス詳細に一致する単一サーバーを解決します。

sft ssh

引数として渡されたターゲットにSSHを介して接続します。

一般的に、アドバンストサーバーアクセスはOpenSSH ProxyCommand統合を使用してsshと共に動作します。sft sshコマンドは、OpenSSHが利用できない環境またはコンテキストでのssh サポートとして、または--viaなどのアドバンストサーバーアクセス固有のオプションを明示的に渡したい場合に使用するよう提供されています。

オプション:

  • --via, --bastion:ターゲットへの接続に使用するSSH 要塞ホスト。
  • --command:SSHを介して実行するコマンド。
  • -L:OpenSSHと同様にローカルポートフォワーディングをサポート。
  • -R:OpenSSHと同様にリモートポートフォワーディングをサポート。

sft ssh-config

~/.ssh/configファイルでの使用に適したOpenSSH構成ブロックを出力し、これによりユーザーのローカルsshバイナリがアドバンストサーバーアクセス認証を使用できるようになります。このSSH構成は、クライアントに現在アクティブで承認されたセッションがある場合に使用されます。

オプション:

  • --via, --bastion:ターゲットへの接続に使用するSSH 要塞ホスト。

sft unenroll

アドバンストサーバーアクセスのプラットフォームのクライアントインベントリーから現在のアクティブクライアントを削除します。

オプション:

  • --all:すべてのローカルクライアントの登録を解除します。

sft use

登録済みのチームを、現在のセッションで使用する現在のデフォルトとして設定します。

sft support

Oktaサポート用にローカルの診断情報を収集します。

オプション:

  • collect:サポートバンドルを作成して.zipファイルに保存します。
  • submit:サポートバンドルを作成して.zipファイルに保存し、Oktaサポートに送信します。

例:

sft support collect

sft support submit

sft help

コマンドのリストまたは1つのコマンドのヘルプを表示します。

セレクター

  • -l, --selector: フィルタリングするセレクター(ラベルクエリ)。

セレクターをオプションの引数として受け取るコマンドは、任意のセレクタークエリに基づき結果をフィルタリングすることができます。

セレクター構文はKubernetesラベルクエリに基づいています。「ラベルおよびセレクター」をご覧ください。

例:

sft list-servers -l os_type=windows,project_name=Demo

この例では、セレクターを使用して、ユーザーがアクセスするサーバーのリストをフィルタリングします。このコマンドは、Demoプロジェクトに登録されているWindowsサーバーを返します。

クライアントを構成する

sft configコマンドを使用すると、構成オプションを表示または設定できます。

アドバンストサーバーアクセスのクライアントのインストール時には構成ファイルは存在しません。最初の構成オプションを設定したときに構成ファイルが作成されます。

ユーザーが構成値を明示的に設定するまで、デフォルトの設定値が使用されます。アドバンストサーバーアクセスのクライアントのデフォルト値は、最大限のセキュリティと最も一般的な状況における使いやすさを提供することを目的としています。rdp.screensizeの設定などの個人的な好みを除いては、いずれのクライアントの構成も全く設定し直す必要はありません。

アドバンストサーバーアクセスのクライアント構成はセクションにグループ化されています。現在、これらのセクションには、rdpsshssh_agentservice_authupdateが含まれます。

構成を表示する

  • sft config:現在の構成を表示します。
  • sft config [section.key]section.keyで示される特定の構成の現在の値を表示します。

構成値を設定する

次のコマンド構文を使用して構成値を設定できます。 sft config [section.key] [value].

RDP 構成オプション

キー

説明

rdp.screensize1024x768など、好みのRDPウィンドウサイズを示す文字列の値に設定します。

sft config rdp.screensize 800x600

sft config rdp.screensize 1024x768

rdp.fullscreenRDPセッションを全画面モードで開きたい場合は、これを true に設定します。これを trueに設定する場合、rdp.screensizeの値は無視されます。

sft config rdp.fullscreen true

sft config rdp.fullscreen false

rdp.client (macOSのみ)これを希望のRDP クライアント(Royal TSX,の場合はroyaltsx、MacFreeRDPの場合はmacfreerdp)に設定します。このオプションが設定されていない場合、アドバンストサーバーアクセスはRoyal TSXの使用を試みた後、Royal TSXが利用できないときはMacFreeRDPを使用します。

sft config rdp.client royaltsx

sft config rdp.client macfreerdp

SSH 構成オプション

キー

説明

ssh.save_privatekey_passwordstrueに設定すると、アドバンストサーバーアクセスのクライアントはユーザーが入力したパスフレーズをワークステーションのローカル暗号化ストアに保存します。

sft config ssh.save_privatekey_passwords true

sft config ssh.save_privatekey_passwords false

ssh.port_forward_methodこれをnetcatに設定すると、アドバンストサーバーアクセスは、デフォルトのネイティブSSH ポート転送を使用する代わりに、ポート転送の手段として、netcat (nc) をリモートで実行します。

sft config ssh.port_forward_method netcat

sft config ssh.port_forward_method native

ssh.insecure_forward_agent

SSHコマンドの実行時にForwardAgentを設定する場合、これをホストに設定します。アドバンストサーバーアクセスが発行した資格情報はssh-agentに追加されないので、このオプションは、アドバンストサーバーアクセスによって管理されていないSSH publicなどの外部管理視覚情報を受け入れるよう構成されたホストで使用するためのものです。

このオプションを設定しないか、noneの値に設定すると、アドバンストサーバーアクセスはSSHエージェントを転送しなくなります。

sft config ssh.insecure_forward_agent host

sft config ssh.insecure_forward_agent none

SSHエージェントの構成オプション

キー

説明

ssh_agent.enabletrueに設定すると、アドバンストサーバーアクセスのクライアントは認証時にSSHエージェントを使用します。

sft config ssh_agent.enable true

sft config ssh_agent.enable false

ssh_agent.keys この値をSSHエージェントにロードするSSHプライベートキーへの単一パスまたは複数のパスのJSON配列に設定します。--append フラグを使用して、このリストに値を追加します。

ヒント: Windows PowerShellでJSONリテラルを書き込む場合、内部引用符をエスケープします。例えば:

sft config ssh_agent.keys '[\"C:\\Users\\alice\\.ssh\\id_rsa\"]'

sft config ssh_agent.keys '["/Users/alice/.ssh/id_rsa"]'

sft config ssh_agent.keys --append /Users/alice.ssh/id_rsa

sft config ssh_agent.keys '[]'

ネットワーク構成オプション

キー

説明

network.forward_proxyこのオプションを構成すると、アドバンストサーバーアクセスのクライアントは指定されたHTTP またはHTTPS URLをHTTP トンネルとして使用します。「HTTP CONNECTメソッド」をご覧ください。

sft config network.forward_proxy https://your-proxy.example.com:3141

network.tls_use_bundled_cas

trueに設定すると、アドバンストサーバーアクセスのクライアントはTLS認証にバンドルされたCA 証明書を使用します。falseに設定すると、クライアントはOSのCAリストを使用します。

注意: このオプションはデフォルトでtrueに設定されており、falseに設定されると、特定のオペレーティングシステムではCA リスト問題が発生する可能性があり、バンドルCA 証明書リストを使用するよりもパフォーマンスが大幅に低下する可能性があるので、このオプションをfalseに設定しないことを強くお勧めします。

sft config network.tls_use_bundled_cas true

sft config tls_use_bundled_cas false

サービス認証構成オプション

キー

説明

service_auth.enabletrueに設定すると、アドバンストサーバーアクセスクライアントはサービスユーザーの認証をサポートします。「サービスユーザー」をご覧ください。

sft config service_auth.enable true

sft config service_auth.enable false

構成オプションを更新する

オプション

説明

update.release_channelアドバンストサーバーアクセスのクライアントは、デフォルトでは安定した更新チャンネルですが、テスト用更新チャンネルを使用するようにオプションを設定することで、より頻繁なリリースを受信することを選択することもできます。

sft config update.release_channel test

sft config update.release_channel stable

環境変数

SFT_DEBUG

設定する場合、コマンドが実行されると内部ログおよびタイミングメッセージがstderrに出力

 SFT_DEBUG=1 sft list-servers  

関連項目

アドバンストサーバーアクセスのクライアントをインストールする

アドバンストサーバーアクセスのクライアントとサーバーを管理する