SSHCommand パラメーター

  • リリースバージョン: Australia
  • 更新日 2026年03月12日
  • 所要時間：7分

    • SSHCommand プローブではいくつかのパラメーターを使用できます。

    プローブパラメーターの設定手順については、「プローブパラメーターを設定」を参照してください。

    表 : 1. パラメーターテーブル
    パラメーター 説明
    allow_unsupported_shells プローブデザイナーが、サポートされているシェルを持たないデバイスでコマンド実行を試行できるようにします。シェルを使用しない場合、次のようになります。
    • パス情報が提供されません。
    • スクリプトパラメーターを処理する機能がないため、スクリプトは機能しません。
    • プローブフォームの [ECC キュー名] フィールドに指定されているテキストは、デバイス上で実行される raw コマンドです。

    たとえば、NX-OS を実行している Cisco スイッチのバージョンを表示するプローブを設計することができます。スイッチが理解できるコマンドは show version です。これを行うには、[ECC キュー名] フィールドに show version コマンドを入れ、値が true のパラメーター名 allow_unsupported_shells を追加します。

    このパラメーターは、sncssh に対してのみ有効です。j2ssh ではサポートされていません。現在サポートされているシェルは、sh、bash、ksh、csh、および tcsh です。

    • タイプ：文字列、true または false
    • デフォルト値：false
    ソース [必要] 接続する最初のホストを指定します。
    • タイプ：文字列 (URL)
    • デフォルト値：なし
    port 接続するターゲットポートを指定します。
    • タイプ：整数 (ポート)
    • デフォルト値：22
    debug SSH デバッグ情報をログファイルに書き込むかどうかを指定します。このパラメーターの使用方法は、ServiceNow SSH クライアントが有効かどうかによって異なります。
    ServiceNow SSH クライアントが有効な場合、このパラメーターは次のように機能します。
    • タイプ：文字列
    • デフォルト値：false
      ServiceNow SSH クライアントには次の文字列の値が有効です。
      • true：ログ ファイル内の SSH デバッグ情報を有効にします。
      • false：ログ ファイル内の SSH デバッグ情報を無効にします。
      • <IP Addresses>：ログファイル内の SSH デバッグ情報を有効にする IP 範囲を指定します。IP アドレスは、次の形式で入力できます。
        • サブネットワーク内のスラッシュとビット数で定義された IP 範囲。たとえば、文字列 10.10.10.0/24 は 24 ビットの IP アドレス 10.10.10.0 から 10.10.10.254 までをスキャンします。
        • ダッシュで定義された IP 範囲。たとえば、文字列 10.10.11.0-10.10.11.165 は IP アドレス 10.10.11.0 から 10.10.11.165 までをスキャンします。
        • 特定の IP アドレスをカンマで区切ったリスト。たとえば、文字列 10.10.11.200,10.10.11.235 は IP アドレス 10.10.11.200 および 10.10.11.235 をスキャンします。
      • deferred：エラーまたは警告が発生しない限り、SSH デバッグ情報をメモリーに記録するよう指定します。エラーまたは警告が発生した場合は、プラットフォームがデバッグ情報をログファイルに公開します。これにより、ログファイルのうちエラーまたは警告に関連する部分のみが確実に記録されるようになります。エラーまたは警告が検出されなかった場合、プラットフォームはセッションの終了時にメモリから未使用のログデータを削除します。各セッションには、最大 1000 件のログメッセージが保存されます。セッションのログメッセージが 1000 件を超えた場合、保留されたログの最も古いログメッセージが破棄され、最新のログメッセージのための空きが確保されます。
    ServiceNow SSH クライアントが無効になっている場合、このパラメーターはログファイル内の SSH デバッグ情報を有効または無効にします。
    • タイプ：true | false
    • デフォルト値：false
    debug_ssh 従来の SSH クライアントが、agent/logs/agent.log ログファイルにデバッグ情報を書き込むかどうかを指定します。
    注:
    このログファイルはすぐに大きくなる可能性があるため、不要な場合は無効にしてください。
    ServiceNow SSH クライアントはこのパラメーターを使用しません。
    • タイプ：true | false
    • デフォルト値：false
    timeout 従来の SSH クライアントのソケット接続タイムアウトを設定します。
    ServiceNow SSH クライアントはこのパラメーターを使用しません。
    • タイプ：整数 (ミリ秒)
    • デフォルト値：60,000
    path_override コマンドを実行する前に設定されているデフォルトのパスを変更する方法を指定します。コロン (:) で区切られた 1 つ以上の上書きパスを入力します。デフォルトのパスは /usr/sbin: /usr/bin: /bin: /sbin です。
    ServiceNow SSH クライアントは、path_overide 値の前に次のプリフィックスを受け入れます。
    • append：上書きパスをホストのパスの末尾に追加します。これはデフォルトの動作です。
    • replace：ホストパスを path_overide 値に置き換えます。
    • prepend：上書きパスをホストパスの先頭に追加します。
    • タイプ：文字列 (コロンで区切られたディレクトリのリスト)
    • デフォルト値：なし
    keyboard_interactive keyboard_interactive SSH ログインモードを強制するかどうかを決定します。
    • タイプ：true | false
    • デフォルト値：false
    must_sudo SSH コマンドを sudo で実行するかどうかを決定します。
    注:
    must_sudo プローブパラメーターはすべてのパターンに影響します。Unix または Linux ホストでは、パターン実行でさまざまなコマンドを実行できますが、一部では sudo を追加しないでください。
    • タイプ：true | false
    • デフォルト値：false
    run_in_terminal SSH 端末で SSH コマンドを実行するかどうかを決定します。
    • タイプ：true | false
    • デフォルト値：
      • ServiceNow SSH クライアント：false
      • 従来の SSH クライアント：true
    set_path プローブがセッションの PATH 変数を変更できるかどうかを決定します。デフォルトでは、セッションのセットアップ時に、PATH 変数は /usr/sbin:/usr/bin:/bin:/sbin に設定されます。
    • タイプ：true | false
    • デフォルト値：true
    rm_override デフォルトの rm コマンド (/bin/rm -f) を指定された値で上書きします。
    • タイプ：文字列
    • デフォルト値：なし
    use_snc_ssh ServiceNow SSH クライアントを有効にします。新しいインスタンスでは、ServiceNow SSH クライアントはデフォルトで有効です。ServiceNow SSH クライアントを有効にすると、従来の SSH クライアントは無効になります。
    • タイプ：true | false
    • デフォルト値：true
    command_timeout_ms タイムアウトになる前に SSH コマンドの実行を許可するミリ秒数です (デフォルトは MID サーバーごとに構成可能)。
    従来の SSH クライアントはこのパラメーターを使用しません。
    • タイプ：整数
    • デフォルト値：mid.ssh.command_timeout_ms の MID サーバーパラメーターの値です。
    channel_timeout_ms MID サーバーが SSH コマンドの処理中にアクティビティを待機する時間 (ミリ秒) を指定します。MID サーバーが指定されたタイムアウト期間内にアクティビティを検出しない場合、このパラメーターはコマンドを強制終了します。
    • タイプ：整数 (ミリ秒)
    • デフォルト値：300000 (5 分)
    preserve_sudo_environment SSH の環境を保持するために sudo を使用するかどうかを指定します。このパラメーターは、プローブ対象ホスト上の sudo 環境が -E スイッチをサポートしている場合にのみ有効です。
    • タイプ：true | false
    • デフォルト値：false
    credentials_debug

    ECC キューに <credentials_debug> セクションを表示します。これは認証情報のトラブルシューティングに役立ちます。このプロパティを true に設定すると、認証情報に問題がない場合でも、認証情報のトラブルシューティング情報が ECC キューに出力されます。詳細については、「認証情報のトラブルシューティング」を参照してください。