View Jobs

ここでは、次の内容について説明します。

Job Manager

Cisco Crosswork Planning では、ツールおよびイニシャライザを、バックグラウンドジョブ（非同期ジョブとも呼ばれる）として動作するようにスケジュールできます。これらのジョブは、展開時に設定された設計エンジンインスタンス上で、バックグラウンドで実行されます。[Job Manager] ページには、これらのジョブの詳細情報が表示されます。

バックグラウンドジョブを使用すると、次のことができます。

  • 優先順位を送信前に設定する

  • 必要な時間に動作するようにスケジュールする

  • [実行中（Running）] 状態に移行する前にキャンセルする

[Job Manager] ページには、CLI およびカスタムスクリプトを使用してジョブを実行するオプションもあります。詳細については、CLI を使用したツールまたはイニシャライザの実行 および 外部スクリプトの実行 を参照してください。

Job Manager のユーザーロール権限

[Job Manager] ページでは、次の操作を実行できます。

  • すべてのユーザーが、他のユーザーが送信したジョブを表示できます。

  • すべてのユーザーが、他のユーザーが送信したジョブの結果を表示できます。

  • すべてのユーザーが、自分が送信したジョブのみをキャンセル（中断）できます。

  • 管理者ユーザーのみが、任意のユーザーが送信したジョブをキャンセル（中断）できます。

View Job Details

送信されたバックグラウンドジョブの詳細を表示するには、次の手順を実行します。

手順

ステップ 1

メインメニューから [Job Manager] を選択します。

[Job Manager] ページが開き、バックグラウンドジョブとして送信されたすべてのジョブのリストが表示されます。

図 1. [Job Manager] ページ

ジョブは作成時刻の降順で表示され、最新のジョブが最初に表示されます。テーブル内のデータをソートするには、列の見出しをクリックします。もう一度列の見出しをクリックすると、ソートの昇順と降順が切り替わります。

列を表示したり非表示にするには、[列の表示/非表示（Show/Hide Columns）] アイコン をクリックします。表示する列のチェックボックスをオンにし、非表示にするオブジェクトのチェックボックスをオフにします。

各列の上部にあるフローティングフィルタの表示を切り替えるには、[フローティングフィルタの表示/非表示（Show/Hide Floating Filters）] アイコン を使用します。このフィルタを使用すると、テーブル内の 1 つ以上の列にフィルタ条件を設定できます。すべてのフィルタをクリアするには、テーブルの上に表示される [フィルタ（Filters）] フィールドの [X] アイコンをクリックします。

ステップ 2

[ステータス（Status）] 列に、状態のタイプ（[完了（Completed）]、[スケジュール済み（Scheduled）]、[キュー済み（Queued）]、[実行中（Running）]、[失敗（Failed）]、[中断（Aborted）]）が表示されます。失敗したジョブの場合に詳細を確認するには、エラーの横にある をクリックします。すべての列の詳細については、表 1を参照してください。

ステップ 3

[出力ファイル（Output file）] 列に、ジョブが正常に完了した後に生成される .tar ファイルが表示されます。出力ファイルの名前をクリックしてローカルマシンにダウンロードし、ファイルを解凍して、更新されたネットワークモデルを表示します。この更新されたネットワークモデルをユーザースペースにインポートしてアクセスします（詳細については、ローカルマシンからのプランファイルのインポートを参照）。

ステップ 4

[アクション（Actions）] 列で > [詳細の表示（View details）] の順にクリックして、送信されたジョブの詳細の包括的サマリーを表示します。

ジョブの状態が [スケジュール済み（Scheduled）]、[キュー済み（Queued）]、または [実行中（Running）] の場合は、[アクション（Actions）] の > [キャンセル（Cancel）] を使用してジョブを中断できます。

表 1. Job Manager の列の詳細

列

説明

[ステータス（Status）]

送信されたバックグラウンドジョブのステータスを示します。表示されるステータスタイプは、[完了（Completed）]、[スケジュール済み（Scheduled）]、[キュー済み（Queued）]、[実行中（Running）]、[失敗（Failed）]、および [中断（Aborted）] です。

[ジョブ（Job）]

ジョブのタイプを示します。

ジョブの送信元によって、表示が異なります。

  • [ネットワーク設計（Network Design）] ページのツールまたはイニシャライザの場合は、[ジョブ（Job）] 列に「Design: Tool/initializer name」と表示されます。

  • [Job Manager] ページの[CLI の使用（Using CLI）] オプションの場合は、[ジョブ（Job）] 列に「Cli: Tool/initializer name」と表示されます。

  • [Job Manager] ページの [スクリプトの使用（Using Script）] オプションの場合は、[ジョブ（Job）] 列に「User-Script」と表示されます。

[ID]

ジョブ ID を示します。ジョブをバックグラウンドジョブとして送信する場合、ジョブ ID が作成され、それがこの列に表示されます。

[ネットワークモデル（Network model）]

ジョブが送信されたネットワークモデルを示します。

[プライオリティ（Priority）]

ジョブの優先順位を示します。ジョブをバックグラウンドジョブとして送信する場合、優先順位を割り当てることができ、それがこの列に表示されます。使用可能なオプションは、[高（High）]、[中（Medium）]、および [低（Low）] です。

[オプション（Options）]

ジョブの送信中に使用される設定オプションを示します。このカラムは、デフォルトではオフになっています。

[出力ファイル（Output file）]

ジョブが正常に完了した後に生成されるファイルを示します。更新されたネットワークモデルにアクセスするには、このファイルをダウンロードします。

[送信時刻（Submission time）]

ジョブが送信されたタイムスタンプを示します。

[開始時刻（Start time）]

ジョブの実行が開始されたタイムスタンプを示します。

[終了時間（End time）]

ジョブの実行が正常に完了したタイムスタンプを示します。

[エンジンホスト名（Engine host name）]

ジョブの実行に使用されるエンジンの名前を示します。

[スケジュール（Schedule）]

ジョブを開始するようにスケジュールされたタイムスタンプを示します。このカラムは、デフォルトではオフになっています。

[送信者（Submitted by）]

ジョブを送信したシステムまたはユーザーの名前を示します。スケジュールされたジョブの場合、ジョブはスケジュールされた時刻にシステムによって送信されるため、この列には「system」と表示されます。他のすべてのジョブについては、[送信者（Submitted by）] 列と [作成者（Created by）] 列に同じ情報が表示されます。このカラムは、デフォルトではオフになっています。

[作成者（Created by）]

ジョブを送信したユーザーを示します。このカラムは、デフォルトではオフになっています。

[アクション（Actions）]

この列の > [詳細の表示（View details）] オプションを使用すると、送信されたジョブの包括的サマリーが表示されます。ジョブの状態が [スケジュール済み（Scheduled）]、[キュー済み（Queued）]、または [実行中（Running）] の場合は、 > [キャンセル（Cancel）] を使用してジョブを中断することもできます。

CLI を使用したツールまたはイニシャライザの実行

[ネットワーク設計（Network Design）] ページからのツールとイニシャライザの実行に加えて、Cisco Crosswork Planning では、CLI を使用してそれらを実行できます。

CLI を使用してツールまたはイニシャライザを実行するには、次の手順を実行します。

手順

ステップ 1

メインメニューから [Job Manager] を選択します。

[Job Manager] ページが開き、バックグラウンドジョブとして送信されたすべてのジョブのリストが表示されます。

ステップ 2

[追加（Add）] アイコン > [CLI の使用（Using CLI）] の順にクリックします。

使用可能なすべてのツールおよびイニシャライザのリストが表示されます。

ステップ 3

必要なツールまたはイニシャライザを選択し、[次へ（Next）] をクリックします。

使用可能なすべてのネットワークモデルのリストが表示されます。

ステップ 4

ツールまたはイニシャライザを実行するネットワークモデルを選択し、[次へ（Next）] をクリックします。

選択できるネットワークモデルの数は、前の手順で選択したツールまたはイニシャライザによって異なります。許容数を超えると、上部にエラーメッセージが表示されます。

ステップ 5

テキストフィールドに入力設定オプションを入力し、[次へ（Next）] をクリックします。

これに関するヘルプについては、[使用方法のヘルプ（Usage Help）] をクリックします。[使用方法のヘルプ（Usage Help）] ページには、特定のツールまたはイニシャライザで使用できる設定パラメータの詳細情報が表示されます。また、構文、必須の設定オプション、任意の設定オプション、およびコマンドの例も示されます。

（注）  

 
任意のオプションのみを入力できます。ツール名と必須のオプションを入力する必要はありません。

このページでは、ツールまたはイニシャライザや、出力ファイルの名前を更新することもできます。

  • ツールまたはイニシャライザを変更するには、すでに選択したツール名の横にある [編集（Edit）] をクリックします。

  • 出力ファイルの名前を更新するには、[出力ファイル（Output file）] フィールドに新しい名前を入力します。デフォルトでは、「tool_out.txt」がファイル名として使用されます。

ステップ 6

[実行設定（Run Settings）] ページで、タスクをすぐに実行するか、後で実行するようにスケジュールするかを選択します。ジョブの優先順位を設定することもできます。次の [実行（Execute）] オプションから選択します。

  • [今すぐ（Now）]：ツール/イニシャライザをすぐに実行するには、このオプションを選択します。

  • [スケジュールされたジョブとして（As a scheduled job）]：タスクを非同期ジョブとして実行するには、このオプションを選択します。このオプションを選択した場合は、ツールを実行する時間を設定します。ツールは、スケジュールされた時間に実行されます。

ステップ 7

[Job Manager] ページでジョブのステータスを追跡します。[ジョブ（Job）] 列では、ジョブ名の前に「Cli:」が付きます。ジョブが正常に完了したら、出力ファイル（.tar ファイル）をダウンロードして解凍し、更新されたプランファイルをユーザースペースにインポートしてアクセスします（詳細については、ローカルマシンからのプランファイルのインポートを参照）。

外部スクリプトの実行

Cisco Crosswork Planning では、OPM および RPC API がスクリプトを介してサポートされます。これらの API を使用して作成された、カスタマイズされたスクリプトをアップロードできます。スクリプトを使用して CLI ツールを実行することもできます。

OPM API は、ネットワークモデルを操作するための強力な Python API を提供します。これにより、デバイス固有のプロパティを気にすることなくネットワーク上で操作できます。基になるルータが別のベンダーのルータに置き換えられても、API 呼び出しはまったく同じままです。

Python スクリプトのサンプルについては、例：外部スクリプトの実行を参照してください。

外部スクリプトを実行するには、次の手順を実行します。

手順

ステップ 1

メインメニューから [Job Manager] を選択します。

[Job Manager] ページが開き、バックグラウンドジョブとして送信されたすべてのジョブのリストが表示されます。

ステップ 2

[追加（Add）] アイコン > [スクリプトの使用（Using script）] の順にクリックします。

ユーザースペースで使用可能なスクリプトのリストが表示されます。

ステップ 3

必要なスクリプトを選択し、[次へ（Next）] をクリックして続行します。

必要なスクリプトがリストにない場合は、[スクリプトのアップロード（Upload script）] オプションを使用してスクリプトをアップロードします。スクリプト名が [使用可能なスクリプト（Available Scripts）] の下に表示されます。スクリプトファイルは、[ネットワークモデル（Network Models）] > [マイユーザースペース（My user space）] > [すべてのファイル（All files）] セクションでも確認できます。

ステップ 4

スクリプトを実行するネットワークモデルを選択し、[次へ（Next）] をクリックします。

ステップ 5

次の形式を使用してテキストフィールドに入力設定オプションを入力し、[次へ（Next）] をクリックします。 

script_name arg1 arg2

必要に応じて、[編集（Edit）] ボタンを使用してスクリプトファイルを変更します。

ステップ 6

[実行設定（Run Settings）] ページで、タスクをすぐに実行するか、後で実行するようにスケジュールするかを選択します。ジョブの優先順位を設定することもできます。次の [実行（Execute）] オプションから選択します。

  • [今すぐ（Now）]：スクリプトをすぐに実行するには、このオプションを選択します。

  • [スケジュールされたジョブとして（As a scheduled job）]：タスクを非同期ジョブとして実行するには、このオプションを選択します。このオプションを選択した場合は、スクリプトを実行する時間を設定します。スクリプトは、スケジュールされた時間に実行されます。

ステップ 7

[Job Manager] ページでジョブのステータスを追跡します。[ジョブ（Job）] 列には、スクリプトジョブの「ユーザースクリプト」が表示されます。ジョブが正常に完了したら、出力ファイル（.tar ファイル）をダウンロードして解凍し、更新されたプランファイルをユーザースペースにインポートしてアクセスします（詳細については、ローカルマシンからのプランファイルのインポートを参照）。

例：外部スクリプトの実行

この例では、Cisco Crosswork Planning で外部スクリプトを使用する方法について説明します。サンプルの Python スクリプト（ext_exe_eg.py）は、ネットワーク内のすべてのインターフェイスに「私の IGP メトリックは <value>（My IGP metric is <value>）」という説明を付加します。

ext_exe_eg.py の内容：

import sys
from com.cisco.wae.opm.network import Network

src  = sys.argv[1]
dest = sys.argv[2]

srcNet =  Network(src)

for node in srcNet.model.nodes:
    cnt = 1
    for iface in node.interfaces:
        iface.description = 'My IGP metric is ' + str(iface.igp_metric)
        cnt = cnt + 1    

srcNet.write(dest)

このスクリプトをアップロードし、外部スクリプトの実行 に記載されている手順でそれを Job Manager から実行します。次のコマンドを使用します。 

ext_exe_eg.py input-plan.pln out-plan.pln

ジョブが正常に完了したら、[Job Manager] ページから出力ファイル（.tar ファイル）をダウンロードして解凍し、更新されたプランファイルをユーザースペースにインポートしてアクセスします。