コマンド検証ツール - Support and Troubleshooting

コマンド検証ツール .ns-kb-css-body-editor-container { p { font-size: 12pt; font-family: Lato; color: #000000; } span { font-size: 12pt; font-family: Lato; color: #000000; } h2 { font-size: 24pt; font-family: Lato; color: black; } h3 { font-size: 18pt; font-family: Lato; color: black; } h4 { font-size: 14pt; font-family: Lato; color: black; } a { font-size: 12pt; font-family: Lato; color: #00718F; } a:hover { font-size: 12pt; color: #024F69; } a:target { font-size: 12pt; color: #032D42; } a:visited { font-size: 12pt; color: #00718f; } ul { font-size: 12pt; font-family: Lato; } li { font-size: 12pt; font-family: Lato; } img { display: ; max-width: ; width: ; height: ; } } コマンド検証ツール

問題は何ですか？

ユーザーが IP アドレスの範囲でコマンドを実行できるようにするツールがありません。このようなツールがないと、インスタンスに存在する認証情報に対して IP アドレス上のコマンドが検証されることはありません。特定のコマンドが期待どおりに実行されなかったディスカバリーに失敗した場合、ほとんどの場合、ユーザーは MID サーバーがインストールされている仮想マシンからコマンドを実行して、そのような検証を実行するように求められます。

私たちは何をしていますか?

ユーザーが特定のオペレーティングシステムに属するIPアドレスの範囲でコマンドを実行できるようにするアプリケーションを実装しました。ユーザーは、この操作の MID サーバーの選択方法を選択することもできます。この操作の出力は、実行が成功したかどうかを示します。

すべてのコマンドは、インスタンスに存在するすべてのディスカバリーパターンを解析することによって毎日入力されるコマンドリストから使用できます。コマンドリストには、シェル、WMI、およびSNMPプロトコルに属するコマンドが含まれています。

どのように解決されていますか?

最も一般的な操作タイプとプロトコルをサポートするコマンド検証ツールの導入により、ユーザーは ServiceNow インスタンス内からコマンドを実行して検証できるようになりました。

コマンド検証ツールは、次の操作をサポートしています。

シェルコマンド WMI クエリ SNMP クエリ (表形式およびスカラー) SNMP ウォーク HTTP GET (ベーシック認証情報で認証)

次の MID 選択方法を使用できます。

特定の MID サーバー MID サーバーの自動選択 対象となるすべての MID サーバーを試す

ユーザーは、次の方法で IPv4 アドレスを入力として指定できます。

カンマ区切り IP アドレス IP 範囲 IP ネットワーク 上記のすべての組み合わせ

すべてのコマンド検証には、次の情報が含まれます。

ステータス:成功/失敗 ステータス:処理待ち/処理中/完了 結果:デバイスからの応答/失敗の理由 コマンド検証に使用される認証情報 失敗した場合: ServiceNow ディスカバリー固有のエラーコード エラーコードに基づくトラブルシューティング手順

要件とユースケース:

ディスカバリーの失敗のトラブルシューティング :ディスカバリーでエラーが発生した場合は、コマンド検証ツールを使用して、対応する MID サーバーを使用して、対応する IP アドレスで失敗したコマンドを再実行できます。これは、次の検出に使用できます。 認証の問題 認証/権限の問題 有効な認証情報がありません MID から IP に到達できません 構文が間違っているコマンド MID 構成に関する問題

ServiceNow パターンベースのディスカバリー への新しいインフラストラクチャのオンボーディング:選択したパターンのすべてのコマンドを検証できるため、コマンド検証ツールを使用して新しいインフラストラクチャをオンボーディングできます。これにより、ユーザーは、新しく追加された IP アドレスが、大きなエラーなしにパターンを介して検出されるようにすることができます。

コマンドの一括実行 :コマンド検証ツールを使用して、任意のコマンドを (コマンドリストから使用できる限り) IP 範囲で実行し、特定の構成を確認できます。

注意 :アプリケーションはドメインセパレーションをサポートしています。

機能フロー:

コマンド検証ツールは、<a title="パターンデザイナーの機能拡張" href="https://store.servicenow.com/sn_appstore_store.do#!/store/application/f73627bf89228510f877b828becf35e9/2.0.0?referer=%2Fstore%2Fsearch%3Flistingtype%3Dallintegrations%25253Bancillary_app%25253Bcertified_apps%25253Bcontent%25253Bindustry_solution%25253Boem%25253Butility%25253Btemplate%26q%3Dpattern%2520designer%2520enhancmenets&sl=sh" target="_blank" rel="noopener noreferrer"> 「パターンデザイナー機能拡張」ストアアプリ から入手できます。

コマンド検証ツールを取得するには、まずプラグインのリストを使用してパターンデザイナー拡張機能をインストールします:

アプリケーションのインストール後、更新してナビゲーションメニューで「コマンド検証ツール」を検索すると、関連するメニュー項目が表示されます。

[コマンド検証ツール] の下に、次の 4 つのモジュールがあります。

新規作成:コマンド検証の単一の実行エンティティを表す新しいコマンド検証タスクを作成します。 コマンド検証タスク:タスクのリストを表示するには コマンド検証タスクの結果:コマンド検証タスクの結果のリストを表示します。 コマンドリスト:パターンから解析されたすべてのコマンド (SHELL、WMI、および SNMP タイプ) が含まれます。

新しいコマンド検証タスクの作成:

[新規作成] をクリックすると、次のフォームが開きます:

以下の情報が必要です。

MID サーバーの選択方法: 次の 3 つのオプションのいずれかを選択します。 特定の MID サーバー:必須になります。[MID サーバー] フィールドで特定の MID サーバーを選択するには。 MID サーバーの自動選択:最初に、テーブルにクエリを実行して、指定された IP に特定の MID サーバーに対する親和性があるdscy_credentials_affinityを確認します。親和性がない場合は、設定パラメーターに目的の IP 範囲とアプリケーションが「ディスカバリー」を含むように設定されている MID サーバーが選択されます。 対象となるすべての MID サーバーを試す:指定された IP アドレスに親和性があるすべての MID サーバーと、構成パラメーターに目的の IP 範囲とアプリケーションが「ディスカバリー」を含むよう設定されている MID サーバーが選択されます。

OS クラス :IP アドレスが属する関連 OS (CMDB CI) クラス。ユーザーは正しい OS クラスを指定することが期待されます。この情報は、コマンドの実行時に考慮するポートとプロトコルの実装を決定するために MID サーバーによって使用されます。間違った OS クラスが指定された場合、コマンドの実行は失敗することに注意してください。例:入力したすべての IP が Linux サーバーである場合、OS クラスとして [Linux サーバー (cmdb_ci_linux_server)] を選択します。

コマンドタイプ :IP アドレスで実行するコマンドのタイプ。シェル、WMI クエリー、SNMP クエリー、SNMP ウォーク、または HTTP GET にすることができます。

注 :

選択した OS サーバーで実行できるようにコマンドタイプを選択します。選択した IP アドレスは、選択した OS タイプに属している必要があります。たとえば、Linux サーバーでは WMI クエリを実行できません。 HTTP Get コマンドタイプは、API 呼び出しの認証情報が基本認証情報として存在する場合にのみ機能します。トークンベースの認証情報は、この操作ではまだサポートされていません。これは、フィールドメッセージを介しても伝えられます。

IP アドレス :次の方法で入力として IP4 アドレスを指定します。 カンマ区切り IP アドレス IP 範囲 (1.1.1.1-1.1.1.100) IP ネットワーク (1.1.1.1/28) カンマ区切りの IP アドレス、IP 範囲、および IP ネットワーク。 IP とポート (HTTP Get コマンドのみ)

注 :

ユーザーは、検出によってまだ検出されておらず、CMDB で利用できない IP アドレスを指定できます。この場合、コマンドを正常に実行するためには、顧客が認証情報テーブルに保存されている IP アドレスの適切な認証情報を持っている必要があります。 IP 範囲と IP ネットワークは、「 ParseIPRanges 」スクリプトインクルードがインスタンスにインポートされている場合にのみ機能します。この KB に添付されているスクリプトインクルードを参照してください。

コマンド :指定された IP アドレスで実行するコマンドのリスト。コマンドリストテーブルからのみ選択できます。検索アイコンをクリックすると、選択した [コマンドタイプ] フィールドと [適用可能な OS クラス] フィールドに従って、[コマンドリスト] テーブルのコマンドのみが表示されます。 注 :

[コマンド] のフィールドメッセージには、コマンドリストが最後に更新された日時、または空の場合は入力方法が示されます。 コマンドがコマンドリストテーブルに存在する構文を以下に示します。 コマンドタイプ

コマンド構文

IP 構文

シェル

command

変更なし

WMI クエリ

["名前空間"][スペース]「WMI クエリー」

変更なし

SNMP スカラークエリ

OID

変更なし

SNMP 表形式クエリ

oid[スペース][カンマ区切りの列番号]、

変更なし

SNMP ウォーク*

OID

変更なし

HTTP GET*

httpEndpoint、

ip:port

* ツールには「SNMP ウォーク」と「HTTP GET」を実行する機能がありますが、コマンドリストテーブルは現在それらをサポートしていません。

[すべてのパターンコマンドを検証 (Validate All Pattern Commands)] :指定された IP に対して特定のパターンからすべてのコマンドを実行する場合は、このチェックボックスをオンにします。ユーザーがこれを確認すると、[コマンド] フィールドが [パターン] フィールドに置き換えられ、コマンドではなく選択したパターンに応じてコマンド検証タスクが実行されます。 フェイルオーバーコマンドの手順をスキップ :[すべてのパターンコマンドを検証] チェックボックスが有効になっている場合、このチェックボックスが有効になります。これをチェックすると、コマンド検証タスクを実行してすべてのパターンコマンドを検証するときに、すべてのフェイルオーバーコマンドがすべてスキップされます。 パターン :このフィールドはデフォルトでは非表示になっており、[すべてのパターンコマンドを検証] チェックボックスが有効になっている場合にのみ表示されます。選択したパターンに存在するすべてのコマンドは、指定された IP に対して実行されます。現在、選択できるのはインフラストラクチャパターンとアプリケーションパターンのみです。コマンドリストにはこれらのパターンタイプのコマンドのみが入力されます。 [ハードウェアを選択] :このチェックボックスを有効にすると、[ハードウェア] という新しいフィールドが表示され、[IP アドレス] フィールドが非表示になります。ユーザーは、IP アドレスを指定するのではなく、コマンド検証を実行する必要がある CI を直接選択できます。 ハードウェア :このフィールドはデフォルトでは非表示になっており、[ハードウェアを選択] チェックボックスが有効になっている場合に表示されます。このフィールドでは、コマンド検証の実行が意図されている、選択した OS クラスに従ってハードウェア CI を直接選択できます。 優先度 :値が小さいタスクには、MID サーバーによる実行の優先度が高くなります。スケジューラーは、処理待ちステータスの優先度の高いコマンド検証タスクの結果レコードを最初に選択します。 認証情報 :コマンド検証タスクを介してコマンドを検証するために使用する特定の認証情報を指定します。これはオプションです。選択しない場合、MID サーバーは親和性と順序に基づいて使用する適切な認証情報を選択します。 注意:この機能は Utah リリース以降でのみサポートされており、シェル、WMI、および SNMP 操作をサポートしています。

完了したら、レコードを保存するか、すぐに [コマンド検証を実行] ボタンをクリックしてコマンド検証の実行を開始できます。

[コマンド検証を実行] ボタンをクリックすると、指定されたコマンド、IP アドレス、および MID サーバーごとにコマンド検証タスクの結果レコードが作成されます。

たとえば、タスクに 3 つの IP アドレス、2 つのコマンド、および 1 つの MID サーバーが構成されている場合、6 つのタスク結果レコードが作成されます。

コマンド検証タスクの結果レコードは、コマンド検証タスクの実行の進捗状況を追跡するために使用されます。

コマンド検証タスクの結果レコードのステータス:

保留中:スケジューラーによって選択され、MID サーバーにディスパッチされていません 処理中:スケジューラーがレコードを選択し、実行のために MID サーバーにディスパッチしました 完了:コマンドの実行が完了し、結果が作成されます。

タスクの進捗状況とステータスは、タスクレコード内で監視することもできます。

コマンド検証プローブの起動ジョブをスケジュール:

このスケジュール済みジョブの責任は、保留中のすべてのコマンド検証タスク結果レコードを先入れ先出しベースで定期的に (デフォルトでは、スケジューラーは 15 秒ごとに実行されるように構成されています)、コマンド検証プローブを介してそのコンテンツをバッチ (デフォルトでは 10 回) で ECC キューに送信します。ユーザーは、環境、インスタンス、および MID 構成に応じてバッチサイズと頻度をカスタマイズできます。

バッチサイズを設定するには、次のシステムプロパティを使用します。 command.validation.probe.batch.count

コマンドリストテーブル:

これは 2023 年 2 月リリースで導入されました。

このテーブルには、共有ライブラリや拡張セクションを含む、すべてのインフラストラクチャおよびアプリケーションパターン内に存在するシェルコマンド、WMI クエリー、および SNMP クエリーが保持されます。

2023 年 8 月リリース以降、コマンドリストには一時変数を含むコマンドも保持されます。コマンド内の一時変数は、「$」で始まり、「#」で終わります。

コマンドリストは許可リストとして機能し、コマンド検証タスクの作成時にお客様が選択できるコマンドのプールです。

コマンド検証ツールは、選択したパターンに属するコマンドリスト内のすべてのコマンドを取得するため、ユーザーが「すべてのパターンコマンドを検証」を実行することを選択した場合にも、コマンドリストが使用されます。

コマンドリストテーブルは空で配信されます。次の 2 つのメソッドのいずれかで入力されます。

「CVT-Populate CmdList and Mappings」という名前のスケジュール済みジョブ。テーブルを最新の状態に保つために 1 日に 1 回実行されます。パターンに加えられた変更 (新しいコマンドを含むステップが追加されたか、既存のステップが削除または変更された場合など) は、その日の終わりまでに反映され、古いレコードは残りません。 ユーザーが何らかの変更を行い、コマンドリストにそれらをすぐに反映させたい場合は、[コマンドリスト] テーブルのリストビューにある [コマンドリストを更新] ボタンを使用します。以下は、コマンドリストのスクリーンショットで、上部に [コマンドリストを更新] ボタンがあります。入力プロセスが完了するまでに数分かかることに注意してください。

注 :

コマンドリストの入力プロセスでは、SHELL、WMI、および SNMP タイプのコマンドのみが解析されます。

コマンド検証タスクをキャンセル:

この機能は、2023 年 2 月のストアリリースで導入されました。

コマンド検証タスクが送信されると、[コマンド検証タスク] フォームの下部にある [コマンド検証タスクの結果] 関連リストに [コマンド検証タスクをキャンセル] ボタンが表示されます。このボタンをクリックすると、保留中ステータスのすべてのコマンド検証タスク結果レコードがキャンセルされ、ステータスが「キャンセル」に変更されます。これらのレコードの場合、コマンド検証プローブは起動しません。

処理ステータスのコマンド検証タスクの結果レコードは、最終的に完了するまで MID サーバーによって既に処理されているため、キャンセルされないことに注意してください。

リストパターンコマンド:

ユーザーがsa_patternテーブルを開いて任意のパターンで右クリックを実行すると、新しいオプション「パターンコマンドのリスト」が表示されます。同じものをクリックすると、選択したパターンに属するすべてのコマンドが一覧表示されるコマンドリストテーブルにリダイレクトされます。ユーザーはさらにリストをエクスポートできます。

ユーザーがsa_patternテーブルでパターンレコードを開くと、前述と同じ名前の新しい UI アクションが表示されます。それをクリックすると、選択したパターンに属するすべてのコマンドが一覧表示されるコマンドリストテーブルにリダイレクトされます。ユーザーはさらにリストをエクスポートできます。

コマンドアクションを表示:

[コマンドを表示] 関連リンクは、[すべてのコマンドパターンを検証] フィールドがオンになっており、タスクレコードが保存されている場合にのみ表示されます。[コマンドを表示] をクリックすると、コマンド検証タスクで選択したパターンに従って実行されるように構成されているコマンドのリストが表示されます。これは、コマンド検証が送信された後に実行されるすべてのコマンドをユーザーが把握するのに役立ちます。

一時変数マッピングをリフレッシュ:

ユーザーが一時変数を含むコマンドリストからコマンドを選択した場合、前述の UI アクションによって、関連テーブル [一時変数マッピング] のすべての一時変数が入力されます。一時変数の値はホストごとに異なるため、一時変数は IP/ホストごとに入力されます。[一時変数マッピング] テーブルに入力されたすべてのレコードには、一時変数、ステップ名、パターン名、および IP アドレスが含まれます。[値] フィールドにのみ、初期値として「値なし」が入力されます。ユーザーは [値] フィールドにのみ入力する必要があります。選択した IP アドレスまたはコマンドを追加/削除し、タスクレコードを保存して UI アクションをクリックすると、指定された IP とコマンドに従って一時変数マッピングテーブルのレコードが追加/削除されます。結論として、選択したコマンドに一時変数が存在する場合、ユーザーは Ui アクションを確実に使用する必要があります。

注意：

一時変数を含むコマンドはカンマ区切りの IP アドレスに対してのみ実行され、入力として IP 範囲または IP ネットワークを指定することはできません。 [すべてのパターンコマンドを検証 (Validate All Pattern Commands)] で CVT を実行すると、一時変数を含むコマンドはスキップされ、実行されません。静的コマンドのみが実行されます。 一時変数を含むコマンドは、すべての一時変数の値が一時変数マッピングテーブルで指定されている場合にのみ実行されます。

失敗したコマンド実行のトラブルシューティング

コマンド検証ツールは、コマンドの実行が失敗した場合のトラブルシューティング手順を提供します。コマンド検証タスクの結果のステータスが「失敗」で終了した後、レコードのフォームを開くと、「失敗のトラブルシューティングを行うための提案を開く」という名前の関連リンクが表示されます。

クリックすると、このエラーのトラブルシューティング方法に関する提案を含むダイアログボックスが開きます。この提案は、コマンド検証タスクの結果レコードに存在するエラーコードにマッピングされます。下のスクリーンショットを確認してください。

エラーコードから提案へのマッピングは、ベースシステムに付属していることに注意してください。エラーコードがどの提案にもマッピングされない場合があります。このような場合、ダイアログに表示されるメッセージはそれを反映しています。

実例:

下のスクリーンショットでは、Linux サーバーに属する IP アドレスで「date」と「hostname」の 2 つのシェルコマンドを実行するようにコマンド検証タスクを設定しています。

実行する特定の MID サーバーを選択し、特定の認証情報は選択せず、MID サーバーに選択させます。

両方のコマンドの実行に成功し、それぞれの結果を確認できます。

リリース情報

リリース:2023年11月ストア

アプリケーションバージョン:3.3.0

前のバージョン:3.1.0

注意:これは、このスコープ対象のアプリケーションの 5 番目のリリースです。