--- sourceDocument: Yokohama データと自動化 sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/yokohama/integrate-applications Release : - yokohama ft:locale : - ja-JP ft:publication_title : - Yokohama データと自動化 ft:clusterId : - crint bundleId : - crint workflow : - Creator --- # SSH アクティビティを作成する # SSH アクティビティを作成する {#ariaid-title1} * リリースバージョン: Yokohama * * 更新日 2025年01月30日 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：9分 SSH ネットワーク プロトコルを使用するターゲット ホストからデータを抽出するアクティビティを作成します。 ## 始める前に 必要なロール：activity_creator または workflow_admin ## このタスクについて アクティビティテンプレートのプロセスフローの使用手順については、「[カスタムアクティビティを作成する](https://servicenow-prod.fluidtopics.net/edsmpnP6ixAb8otUf3QAfg "カスタム テンプレートを使用して、ワークフローエディターでさまざまなタイプのカスタムアクティビティを作成および更新できます。")」を参照してください。 ## 手順 1. [カスタムアクティビティ](https://servicenow-prod.fluidtopics.net/edsmpnP6ixAb8otUf3QAfg "カスタム テンプレートを使用して、ワークフローエディターでさまざまなタイプのカスタムアクティビティを作成および更新できます。")を作成します。 このアクションにより、テンプレートを使用してカスタムアクティビティが作成されます。 2. [一般的なプロパティ](https://servicenow-prod.fluidtopics.net/sGlDz~awf9LAqxmmckTzIA "次の一般プロパティ フィールドは、すべてのアクティビティデザイナーテンプレートに共通です。")を設定し、[入力変数を作成](https://servicenow-prod.fluidtopics.net/EdYKCS6jB0~8LVv2H_rDTw#CreateInputVariables "アクティビティデザイナーの [入力] フォームで、アクティビティに渡す変数を作成します。")した後、SSH 実行コマンドを構成します。 | オプション | 説明 | | [入力変数をマップする](https://servicenow-prod.fluidtopics.net/EdYKCS6jB0~8LVv2H_rDTw#t_MapAnInputVariable "入力変数を作成した後、[実行コマンド] フォームのフィールドにその入力変数をマップします。") | 作成した変数を使用して、オーケストレーションが実行するコマンドを設定します。 | | ターゲットホスト | このアクティビティのターゲットサーバーのホスト名または IP アドレス。 | | コマンド | このアクティビティがターゲット ホスト上で実行するコマンド。SSH コマンド ラインがサポートする任意のスクリプト タイプを使用して、このフィールドから MID サーバースクリプトを呼び出すことができます。詳細については、表の下の「詳細な SSH スクリプト オプション」を参照してください。 | | ディレクトリ | コマンドが実行されるターゲット ホスト上のディレクトリー。 | | 認証情報タグ | コマンドを実行するときに使用するオーケストレーション認証情報タグ。 | | 必要な MID サーバー機能 | ホストに接続するための適切な機能を備えた MID サーバー。デフォルトでは、SSH 機能を備えた MID サーバーが選択されます。 | | 長期間 | オンにされていると、コマンドの実行がデフォルトの 60 秒よりも長くかかる場合に SSH 接続タイムアウトを無効にします。オーケストレーションは実行中のプロセスを定期的にチェックし、完了するまでそのステータスを判断します。 | | Sudo が必要 | オンにされていると、コマンドを実行するために [sudo](https://www.servicenow.com/docs/access?context=r_SSHCredentialsForm&version=yokohama&pubname=yokohama-platform-security&ft:locale=en-US) の使用を有効にします。 | |-|-| {#t_CreateAnSSHActivity__choicetable_j2l_k2s_d1b} 注: テストペイロードのパラメーター値を、\[出力\] タブの変数に自動的にマッピングできます。「[出力変数を自動マッピングする](https://servicenow-prod.fluidtopics.net/H5szOU~CdbJIOFsdYZzNdQ "テストペイロードのパラメーター値を、[出力] タブの変数に自動的にマッピングできます。")」を参照してください。 ## SSH スクリプトの詳細オプション ターゲットホストで MID サーバー スクリプトを実行するには、スクリプトのタイプを指定して、スクリプトの名前を `${syncFile()}` パラメーターに渡します。システムでは、このパラメーターを使用して、MID サーバースクリプトファイル \[ecc_agent_script_file\] テーブル内の名前付きのスクリプトを見つけ、ターゲットホストで実行します。たとえば、bash スクリプトは次のように表すことができます。 bash ${syncFile("")} argument1 argument2 argument3 基本スクリプト (`main_script.bash`) は、ターゲットホスト上にある別のファイル (`.my_profile`) に関する別のスクリプト (`my_include.bash`) を参照できます。`${syncFile()}` パラメーターを使用して適切に実行するには、スクリプトと参照されたファイルの両方を MID サーバー に同期する必要があります。 source ${syncFile(".my_profile")} cp ${syncFile("my_include.bash")} /usr/ssmith/my_include.bash bash ${syncFile("main_script.bash")} one two three four five six rm /usr/ssmith/my_include.bash インラインコメントのある Python の例は、次のようになります。 set $LIB_DIR=/usr/bin;. # Sync a file that is referenced inside myF5CreateLBPool.py cp ${syncFile("specialFunctions.py")} ~/specialFunctions.py # set up environment variables source ${syncFile(".python_profile")} # call script that sets up dependencies on the box from remote package repos python ${syncFile("setupPythonDependencies.py")} pycontrol # call a script that requires functions from the package as well as a function from myIncludedFile python ${syncFile("myF5CreateLBPool.py")} snow_pool myActualValue # user is responsible for their own cleanup rm ~/specialFunctions.py ## 次のタスク * [自動マッピング](https://servicenow-prod.fluidtopics.net/H5szOU~CdbJIOFsdYZzNdQ "テストペイロードのパラメーター値を、[出力] タブの変数に自動的にマッピングできます。")を使用して出力および解析ルールを生成する * 自動マッピングを使用しない場合は、手動で[出力変数を作成](https://servicenow-prod.fluidtopics.net/8VMx5hDk1zBhXX8PdOseTQ#t_CreateAnOutputVariable "デザイナーの [出力] フォームには、オブジェクトとアレイのデータ構造を作成するための変数ビルダが含まれています。")し、[解析ルールを作成](https://servicenow-prod.fluidtopics.net/WcjbpLvpo7gVqPKWISlRNQ#t_CreateAParsingRule "カスタムアクティビティで定義された出力変数に、外部ホストまたはエンドポイントでの入力テストから返されたペイロード データを取り込みます。")できる {#t_CreateAnSSHActivity__ul_u45_vbq_xz} ## SSH テンプレート実行パラメーター {#ariaid-title2} 実行パラメーターを使用して、アクティビティデザイナーの \[前処理\] フォームで入力プロセス スクリプトを作成します。 コマンド フィールドの説明については、「[SSH 実行コマンドを設定する](https://servicenow-prod.fluidtopics.net/Nb2SVa1adI2JQujewPF57Q#t_MapSSHVariablesToExecutionCommand "作成した変数を使用して、オーケストレーションがホスト ターゲットで実行するコマンドを設定します。")」を参照してください。 注: この表のすべての変数で `executionParam.` プリフィックスを使用する必要があります。 {#r_SSHTemplateExecutionParameters__table_wl1_yxc_dr__entry__4} | 名前 | 変数 | タイプ | 使用法 | |-|-|-|-| | ソース | ソース | 文字列 | 意図したターゲットまたはホスト。 | | コマンド | command | 文字列 | ホスト上で実行するコメント。 | | ディレクトリ | directory | 文字列 | コマンドを実行するホスト上のディレクトリー。 | | 認証情報タグ | credential_tag | 文字列 | コマンドを実行するときに使用するオーケストレーション認証情報タグ。 | | MidCapabilities | midCapabilities | 文字列 (コンマ区切り) | 必要な MID サーバー機能のリスト。 | | ValueCapabilities | valueCapabilities | ハッシュマップの配列 | MID サーバーの選択に使用される機能値。詳細については、「[MID サーバーの機能](https://www.servicenow.com/docs/access?context=t_ConfigureCapabilities&version=yokohama&pubname=yokohama-servicenow-platform§ion=r_MIDServerCapabilities&ft:locale=en-US)」を参照してください。値によって割り当てられる追加の機能がある場合は、次の例を使用して MID サーバーの選択をカスタマイズします。 var valueCapability = {'NEW_MID_CAPABIILTY':'NEW_MID_CAPABILITY_VALUE'}; executionParam.valueCapabilities.push(valueCapability); | | 長期間 | long_running | ブール | コマンドが長時間実行されているかどうかを示します。true の値は、コマンドが長時間実行されていることを示します。 | | Sudo が必要 | must_sudo | ブール | このアクティビティが root コマンドを実行するために sudo を使用する必要があるかどうかを示します。true の値は、[sudo](https://www.servicenow.com/docs/access?context=r_SSHCredentialsForm&version=yokohama&pubname=yokohama-platform-security&ft:locale=en-US) [SSH 認証情報](https://www.servicenow.com/docs/access?context=r_SSHCredentialsForm&version=yokohama&pubname=yokohama-platform-security&ft:locale=en-US)を使用する必要があることを示します。 | [表 : 1. SSH 実行パラメーター] {#r_SSHTemplateExecutionParameters__table_wl1_yxc_dr} ## SSH 後処理パラメーターとペイロード解析 {#ariaid-title3} これらのパラメーターを使用して、後処理スクリプト、ペイロード解析、およびタグ付けを作成します。 {#SSH-payload-parsing-tags__table_nzv_q1d_dr__entry__4} | 名前 | 変数 | タイプ | 使用法 | |-|-|-|-| | 出力 | 出力 | 文字列 | SSH コマンドから返された出力が含まれています。 | | EccSysID | eccSysID | 文字列 | アクティビティによって返された ECC キュー入力メッセージに関連付けられた参照 ID が含まれています。 | | ErrorMessages | errorMessages | 文字列 | SSH コマンドから取得したエラーメッセージが含まれています。エラーメッセージがない場合、この値は null です。 | | タグ | tags | SSH コマンドから返されたタグ値のハッシュマップ | SSH コマンドを使用して出力を抽出するために使用されるタグが含まれています。タグ出力は、次のように二重のパーセント記号で区切られます。`%%tagname%% ... %%`。次の形式を使用してコマンドを設定します。 %%tagname1%% output1 line 1 output1 line 2 ... %% %%tagname2%% output2 line 1 output2 line 2 ... %% 返されるタグは JavaScript ハッシュマップ オブジェクトで、各キーには tagname が付加された `tag` がプリフィックスとして付いています。 {"__text__": "", "tagtagname1":"output1 line1\noutput1 line2\n", "tagtagname2":"output2 line1\noutput2 line2\n"} | [表 : 2. SSH 後処理パラメーター] {#SSH-payload-parsing-tags__table_nzv_q1d_dr} ## SSH 実行コマンドを設定する {#ariaid-title4} 作成した変数を使用して、オーケストレーションがホスト ターゲットで実行するコマンドを設定します。 ### 始める前に \[実行コマンド\] ステージに進む前に、\[入力\] フォームで必要な入力変数を作成します。 必要なロール：activity_creator、admin 注: MID サーバーとターゲット間の SSH 接続は、ワークフロー コンテキストでアクティビティを実行しなくてもテストできます。詳細は、「テスト テンプレート出力」を参照してください。 ### 手順 1. 入力のリストから変数をドラッグし、コマンド フィールドにドロップします。 システムによって、コマンドの正しい構文で変数がフォーマットされます。 図 : 1. SSH 実行コマンド 2. 表に示されたフィールドに入力します。 {#t_MapSSHVariablesToExecutionCommand__table_xf4_kvc_dr__entry__2} | フィールド | 説明 | |-|-| | 入力 | 入力変数ビルダー。[入力変数を作成する](https://servicenow-prod.fluidtopics.net/EdYKCS6jB0~8LVv2H_rDTw#CreateInputVariables "アクティビティデザイナーの [入力] フォームで、アクティビティに渡す変数を作成します。")を実行して、使用可能なフィールドにマップします。 | | ターゲットホスト | このアクティビティのターゲットサーバーのホスト名または IP アドレス。 | | コマンド | このアクティビティがターゲット ホスト上で実行するコマンド。 SSH コマンド ラインでサポートされている任意のスクリプト タイプを使用して、このフィールドから MID サーバースクリプトを呼び出すことができます。詳細については、表の下の「詳細な SSH スクリプト オプション」を参照してください。 | | ディレクトリ | コマンドが実行されるターゲット ホスト上のディレクトリー。 | | 認証情報タグ | コマンドを実行するときに使用する [オーケストレーションアクティビティの認証情報エイリアス](https://www.servicenow.com/docs/access?context=c_AssignCredsOrchActivities&version=yokohama&pubname=yokohama-platform-security&ft:locale=en-US)。 | | 機能別に MID サーバーを選択 | ホストに接続するための適切な機能を備えた MID サーバー。デフォルトでは、SSH 機能を備えた MID サーバーが選択されます。 | | 長期間 | コマンドの実行がデフォルトの 60 秒よりも長くかかる場合に SSH 接続タイムアウトを無効にするチェック ボックス。オーケストレーションは実行中のプロセスを定期的にチェックし、完了するまでそのステータスを判断します。 | | Sudo が必要 | コマンドの実行に [SSH 認証情報](https://www.servicenow.com/docs/access?context=r_SSHCredentialsForm&version=yokohama&pubname=yokohama-platform-security&ft:locale=en-US)の使用を許可するチェックボックス。 | [表 : 3. SSH アクティビティ入力] {#t_MapSSHVariablesToExecutionCommand__table_xf4_kvc_dr} 3. \[保存\] をクリックします。 4. \[続行\] をクリックして、\[出力\] ステージに進みます。 {#t_MapSSHVariablesToExecutionCommand__steps_pr1_jlm_s5}