N1 Service Provisioning System 4.1 ユーザーガイド

第 6 章 プラン

プランは、オペレータにより指定された操作をホストに対して実行する XML ドキュメントです。

この章の内容は次のとおりです。

プランの操作

プランは、通常 1 つまたは複数のコンポーネントの操作に使用される、一連の命令です。 たとえば実行プランでは、3 つのコンポーネントをインストールし、別のプランに対する「起動」制御を開始するよう プロビジョニングソフトウェア に指示できます。 プランは別のプランのシーケンスとしても定義できるため、複数のプランで共通の命令シーケンスを共有できます。

プロビジョニングソフトウェア は、プランおよびコンポーネント言語によって表現されるオブジェクトのメモリ内表現を提供し、またこれらのオブジェクトに関する検証、永続化およびバージョン管理のプロセスも定義します。 プロビジョニングソフトウェア では、コンポーネントと関連付けられた物理リソースを管理します。 プロビジョニングソフトウェア がプランを実行する際には、コンポーネントにより宣言される代入変数が置き換えられます。 通知機能を使用すると、プラン実行に関連するイベントに対応して、電子メールを送信できます。 また プロビジョニングソフトウェア には、直接使用したり、ほかのコンポーネントを作成するためのサンプルとして使用できる、数多くの定義済みコンポーネントもあります。

プランの型

N1 Service Provisioning System ソフトウェア モード内では、プランには次の 2 つの型があります。

ほかのサブプランのみを呼び出すトップレベルプランを使用したり、ほかのサブプランへの呼び出しを除く各種のシンプルなステップが含まれる単純プランを使用できるように、XML スキーマによりこれらの制限が課せられます。 この区別が重要であるのは、単純プランに含まれるステップはすべて、同一セットのターゲットホストに実行されるのに対して、複合プランのステップは、複合プランに含まれている各単純プランのターゲットホストのセットを 1 つ再帰的に使用して、さまざまなターゲットホストのセットに対して実行されるためです。

ステップの型

ステップとは、サブプランまたはコンポーネントに関係する内容を管理する、論理ブロックです。 N1 Service Provisioning System ソフトウェア は、次の 3 種類のステップをサポートしています。

プランの XML スキーマ

プランの XML スキーマの詳細な説明は、『N1 Service Provisioning System 4.1 リファレンスガイド』を参照してください。

プランのユーザーインタフェース

「Plans」ページ

「plans」ページでは、プランの一覧表示、プランの詳細の表示、プランの作成、プランの編集を行うことができます。 またこのページには、コンポーネントリストをフィルタリングし、並べ替え条件を選択するためのコントロールもあります。 「plans」ページのカラムの一部には青いくさび型の矢印があります。これを使用すると、昇順または降順でのカラムリストの並べ替えを選択することができます。 矢印の1つをクリックすると、どの矢印をクリックしたかに応じて、そのカラムでは昇順または降順のどちらでリストを並べ替えるかを選択し、矢印を白色に変更します。 白い矢印は、どのカラムが並べ替えに使用されたか、および昇順または降順の並べ替え順序を示しています。

「Path」

検索の場所またはプランの保存場所を指定できます。 別のパスを指定するには、「change path」をクリックします。

「Show」

プランまたはコンポーネントを一覧表示できます。 コンポーネントを選択した場合は、左側のナビゲーションメニューで「components」オプションをクリックした場合と同じように、HTML ユーザーインタフェースには「components」ページが表示されます。

また、「category」プルダウンメニューからカテゴリを選択することで、 リストを限定することもできます。

(チェックボックス)

プランをマークして、「Actions for Checked plans」領域でアクションの 1 つをクリックした場合の対象に追加します。 クリックすると、「Actions for Checked plans」で、プランが削除または分類の対象になります。

「Plan」

プランオブジェクトに名前を付ける、ユーザー定義可能なテキスト文字列です。 デフォルトでは、プランはプラン名によりアルファベット順に一覧表示されます。 「plans header」領域にあるいずれかの並べ替えアイコンをクリックすることで、昇順と降順の並べ替え順序を変更できます。

Version

プランのバージョン番号が表示されます。 プランを変更するたびに、そのバージョン番号は増分されます。

このカラムの「header」領域にあるいずれかの並べ替えアイコンをクリックすることで、プランのリストをバージョン番号で並べ替えることができます。 このアイコンをクリックすると、昇順と降順の順序が切り替わります。

Description

プランオブジェクトを説明する、オプションのユーザー定義テキスト文字列です。 この属性は プロビジョニングソフトウェア によっては使用されませんが、ユーザーに有意義な情報を提供できます。

「Action」

特定のプランの検索、新しいプランの作成、プランに関する詳細情報の表示、プランの実行履歴の表示のいずれかを行うために、ほかのプラン関連のページに移動するリンクです。

「Actions for Checked Plans」

この領域から、チェックしたプランの削除、またはチェックしたプランへのカテゴリの適用を行うことができます。

「Plans Details」ページ

「Plans Details」ページでは、プランの情報と属性を表示することができます。 このページには、プランとその属性の情報だけでなく、プランの実行、編集、および削除を実行できるボタンがあります。

「Plan」

プランの名前です。

「Version」

プランのバージョン番号が表示されます。

「Checked In」

プランがチェックインされた日付と時刻が表示されます。 つまり、作成または変更された日付と時刻です。

「Checked In By」

プランをチェックインしたユーザーのユーザー ID が表示されます。 これは、問題や矛盾のトラブルシューティングを行う際の監査トレールになります。

「Category」

プランリストのフィルタリングに使用する、ユーザー定義可能なオブジェクトです。 カテゴリは、 「Administrative」ページからアクセスする「categories」ページを使用して作成します。 プランへのカテゴリの適用は、「plans」ページから行います。 「Apply Categories...」リンク内をクリックして、カテゴリを作成することも可能です。

「Description」

プランオブジェクトを説明する、オプションのユーザー定義可能なテキスト文字列です。 この属性は プロビジョニングソフトウェア によっては使用されませんが、ユーザーに有意義な情報を提供できます。

ボタン

これらのボタンの 1 つをクリックすることで、以下の機能のうちの 1 つを開始します。

「Run」

プランを実行します。

「Advanced Edit」

プランの XML コードを編集することができます。

「Delete」

データベースからプランを削除します。 複数のバージョンが存在する場合は、プロビジョニングソフトウェア はこのバージョンのみを削除するか、すべてのバージョンを削除するかを確認します。

「Done」

「plans」ページに移動します。

「Download」

XML コードをテキストファイルに保存することができます。 この機能と「Replace Definition With File」機能を使用する間に、プロビジョニングソフトウェア では、ほかのテキストエディタを使用して、プランの XML コードを作成および変更することができます。

「Plans Advanced Edit」ページ

「Plan Advanced Edit」ページでは、プランの XML コードを変更することで、プランの実行内容を変更することができます。

「Plan」

プランの名前を変更できます。

「Version」

プランのリビジョン番号が表示されます。 プランをチェックインすると、これが増分されます。 ユーザーはこれを変更できません。

「Checked In」

これにより、プランをチェックインした新しい日付と時刻が反映されます。 ユーザーはこれを変更できません。

「Checked In By」

これにより、プランをチェックインしたユーザーのユーザー ID が反映されるため、監査トレールになります。 ユーザーはこれを変更できません。

「Category」

プランのカテゴリが表示されます。 カテゴリの割り当てまたは変更は、「Apply Categories ...」リンク内をクリックすることで、「plans」ページから行うことができます。

「Edit The Plan Definition」

これは、プランの実行内容を定義する XML コードが表示される、テキストフィールドです。 このテキストフィールドに、必要な変更を直接行うことができます。

「Replace Definition With File:」

このテキストフィールドでは、「plan definition」フィールドの XML コードを、テキストファイルの XML コードに置き換えることができます。 パスを含めたファイル名をテキストフィールドに入力するか、「browse」ボタンを使用してファイルの位置を指定します。 この機能を開始するには、「browse」 ボタンのすぐ右側にある「Replace」リンクをクリックします。

ボタン

これらのボタンの 1 つをクリックすることで、以下の機能のうちの 1 つを開始します。

「Check in」

現在の名前を使用してプランをチェックインすることができます。

「Check in as」

新しい名前を使用してプランをチェックインすることができます。

「Cancel」

変更を保存することなく「plans」ページに移動します。

Procedureプランリストを表示する

手順
  1. 左側のナビゲーションメニューで、「plans」をクリックします。

    HTML ユーザーインタフェースには、すでにデータベースにチェックインされているプランを一覧表示する、「plans」ページが表示されます。 ヘッダーにあるいずれかの並べ替え矢印をクリックすることで、並べ替え条件を変更できます。

Procedureプランの詳細を表示する

手順
  1. 左側のナビゲーションメニューで、「plans」をクリックします。

    HTML ユーザーインタフェースには、すでにデータベースにチェックインされているプランを一覧表示する、「plans」ページが表示されます。

  2. 目的のプランがある行を見つけ、「details」をクリックします。

    HTML ユーザーインタフェースには、そのプランの「Plan Details」ページが表示されます。

Procedureプランを編集する

手順
  1. 左側のナビゲーションメニューで、「components」をクリックします。

    HTML ユーザーインタフェースには、すでにデータベースにチェックインされているプランを一覧表示する、「plans」ページが表示されます。

  2. 目的のプランがある行を見つけ、「details」をクリックします。

    HTML ユーザーインタフェースには、そのプランの「Plan Details」ページが表示されます。

  3. advanced edit」ボタンをクリックします。

    HTML ユーザーインタフェースには、そのプランの「Plan Advanced Edit」ページが表示されます。

  4. テキストボックスで、プランの XML コードに必要な変更を行うか、別のプログラムで作成した、プラン用の新しい XML を入力します。

    ローカルシステムに保存されているプランをアップロードするには、ファイルのパスを入力するか「browse」ボタンを使用し、それから「Replace」をクリックします。

  5. 「check in」ボタンをクリックして同じ名前を使用するか、「check in as」ボタンをクリックして別の名前を使用します。

    HTML ユーザーインタフェースには、すでにデータベースにチェックインされているプランを一覧表示する、「plans」ページが表示されます。

    HTML ユーザーインタフェースには、ユーザーがこれからプランをチェックインすることを通知する新しいページが表示され、バージョン番号が増分されます。

  6. 「continue」をクリックして、プランのチェックインを完了します。

プランを作成する

自動生成プランを作成する方法、完全なカスタムプランを作成する方法、または自動生成プランから始めてそれをカスタマイズする方法があります。

N1 Service Provisioning System ソフトウェア は、複数の「直接実行」手続きから構成されるプランを自動的に生成できます。 このプランは、直接実行したり、XML で作成するより洗練されたプランのテンプレートとしてとして保存することができます。

複数のコンポーネント、複数のホストセット、またはその両方の同期が含まれる配備に関しては、プランを記述し、プロビジョニングソフトウェア XML スキーマを使用して、依存性チェックや、アプリケーションコンソールでコマンドを実行するスクリプトなどの操作を定義します。 プランの記述が完了すれば、プランリポジトリにそのプランをチェックインする必要があります。

Procedure自動生成プランを作成する

手順
  1. 左側のナビゲーションメニューで、「components」をクリックします。

    HTML ユーザーインタフェースには、すでにデータベースにチェックインされているコンポーネントを一覧表示する、「components」ページが表示されます。

  2. コンポーネントがあるテーブルで、配備するコンポーネントを説明する行を見つけ、「details」をクリックします。

    HTML ユーザーインタフェースには、そのコンポーネントの「Components Details」ページが表示されます。

  3. 「component procedures」テーブルで、プランに追加する各手続きの名前の隣にあるチェックボックスをクリックします。

  4. 追加するすべての手続きを選択したら、「generate plan with checked procedures」というラベルのリンクをクリックします。

    HTML ユーザーインタフェースには、そのプランの「Plan Advanced Edit」ページが表示されます。

  5. 「check in」をクリックします。

Procedureカスタムプランを作成する

TurboXML などのスキーマ検証エディタを使用して XML コードを記述することで作成を開始したり、HTML ユーザーインタフェース内で XML コードを記述することができます。 以降では、外部エディタを使用して XML コードを記述するものとして説明します。

手順
  1. スキーマ検証エディタを使用してプランを記述する場合は、『『N1 Service Provisioning System 4.1 リファレンスガイド』』で説明されている XML スキーマ要素を使用します。

  2. プランの記述が完了したら、Web ブラウザ経由でログインします。

  3. 左側のナビゲーションメニューで、「application deployment」見出しの下にある「plans」をクリックします。

    HTML ユーザーインタフェースには、すでにデータベースにチェックインされているプランを一覧表示する、「plans」ページが表示されます。

  4. プランがあるテーブルの先頭の行で、作成するプランの名前と簡潔な説明を入力して、「create」をクリックします。

    HTML ユーザーインタフェースには、そのプランの「Plan Advanced Edit」ページが表示されます。 プロビジョニングソフトウェア は、XML スケルトンを使用してプラン定義を生成していることに注意してください。

    テキストボックスにプランの XML を入力します。 ローカルシステムに保存されているプランをアップロードするには、ファイルのパスを入力するか「browse」ボタンを使用し、それから「Replace」をクリックします。

  5. 「check in」ボタンをクリックします。

    HTML ユーザーインタフェースには新しいページが表示され、これからプランをチェックインすることが通知されます。 そのプランにはバージョン 1.0 が割り当てられます。

  6. 「continue」をクリックしてチェックインし、プランのチェックインを完了します。

CLI コマンドの概要

表 6–1 には、プランの管理に使用できる CLI コマンドの一覧があります。

表 6–1 pdb コマンドの概要

コマンド 

説明 

pdb.p.ci 

プランの新しいバージョンをチェックインする。 

pdb.p.co 

プランをチェックアウトする (XML でプランを出力する)。 

pdb.p.genplan 

XML でプランを生成および出力する。 

pdb.p.la 

全プランの最新バージョンを一覧表示する。 

pdb.p.lo 

プランを表示する。 

pdb.p.lv 

指定したプランの全バージョンを一覧表示する。 

pdb.p.del 

実行プランを削除する。 

pdb.p.sh 

プランの表示/非表示を切り替える。 

pdb.p.sc 

プランをカテゴリのセットと関連付ける。 


注 –

プランを実行するには、表 6–2 で説明されている pe コマンドを使用します。


セッション変数

セッション変数は、配備に関連付けられているグローバルな値で、プロビジョニングソフトウェア の柔軟性を拡張します。 セッション変数は、作成後に将来配備で使用するために保存可能で、また 1 回の配備に使用するため作成後に保存しないことも可能です。

セッション変数のユーザーインタフェース

「Session Variables」ページ

「Session Variables」ページでは、セッション変数の一覧表示、作成、編集、および詳細の表示を行うことができます。

(チェックボックス)

セッション変数をマークして、「Actions for Checked Session Variables」領域でアクションの 1 つをクリックした場合の対象に追加します。 クリックすると、「Actions for Checked Session Variables」で、セッション変数が削除の対象になります。

「Session Variable」

セッション変数オブジェクトに名前を付ける、ユーザー定義可能なテキスト文字列です。

「Password」

セッション変数の変更にパスワードが必要であるかどうかを表します。

「Value」

セッション変数の値が表示されます。 セッション変数にパスワードが必要である場合、値は楕円の連なりとして表示されます。

「Action」

セッション変数の作成または編集を行うための、ほかのセッション変数関連のページに移動するリンクです。

「Actions for Checked Plans」

この領域から、チェックしたセッション変数を削除できます。

「Session Variables Details」ページ

このページは、セッション変数の詳細の表示に使用します。

「Session Variable」

セッション変数オブジェクトの名前が表示されます。

「Description」

セッション変数を説明する、オプションのユーザー定義テキスト文字列です。 この属性は プロビジョニングソフトウェア によっては使用されませんが、ユーザーに有意義な情報を提供できます。

「Value 」

パスワード保護されている場合を除き、セッション変数の値が表示されます。

「Session Variables 」

セッション変数オブジェクトの名前が表示されます。

ボタン

これらのボタンの 1 つをクリックすることで、以下の機能のうちの 1 つを開始します。

「Delete」

セッション変数を完全に削除できます。

「Edit」

セッション変数の編集ページに移動します。

「Done」

変更を保存せずに「session variables」ページに移動します。

「Session Variables Edit」ページ

このページは、セッション変数の作成と編集に使用します。 既存のセッション変数を編集する場合は、先頭の 2 つの項目は表示されず、変更できません。

「Session Variable 」

セッション変数の名前を入力できるテキストフィールドです。 既存のセッション変数の場合は、このフィールドには名前のみ表示され、 変更はできません。

(チェックボックス)

セッション変数をパスワード保護されているものとしてマークします。 チェックすると、セッション変数の値は楕円の連なりとして表示されます。

「Description」

セッション変数を説明するオプションのテキスト文字列を入力できるテキストフィールドです。 この属性は プロビジョニングソフトウェア によっては使用されませんが、ユーザーに有意義な情報を提供できます。

「Value 」

セッション変数の値を入力できるテキストフィールドです。

「Password」

セッション変数のパスワードを入力できるテキストフィールドです。

ボタン

これらのボタンの 1 つをクリックすることで、以下の機能のうちの 1 つを開始します。

「Save」

変更を保存し、「session variables」ページに移動します。

「Cancel」

変更を保存せずに、「session variables」ページに移動します。

Procedureセッション変数を表示する

手順
  1. 左側のナビゲーションメニューで、「session variables」をクリックします。

    HTML ユーザーインタフェースには、すでにデータベースにチェックインされているセッション変数を一覧表示する、「session variables」ページが表示されます。

Procedureセッション変数の詳細を表示する

手順
  1. 左側のナビゲーションメニューで、「session variables」をクリックします。

    HTML ユーザーインタフェースには、すでにデータベースにチェックインされているセッション変数を一覧表示する、「session variables」ページが表示されます。

  2. 目的のセッション変数がある行を見つけ、「details」をクリックします。

    HTML ユーザーインタフェースには、そのセッション変数の「session variables Details」ページが表示されます。

  3. このページを閉じるには、ページの最下部近くにある「done」ボタンをクリックします。

    HTML ユーザーインタフェースには「session variables」ページが表示されます。

Procedureセッション変数を編集する

手順
  1. 左側のナビゲーションメニューで、「session variables」をクリックします。

    HTML ユーザーインタフェースには、すでにデータベースにチェックインされているセッション変数を一覧表示する、「session variables」ページが表示されます。

  2. 目的のセッション変数がある行を見つけ、「details」をクリックします。

    HTML ユーザーインタフェースには、そのセッション変数の「session variables Details」ページが表示されます。

  3. ページの最下部近くにある「edit」ボタンをクリックします。

    HTML ユーザーインタフェースには、そのセッション変数の「session variables edit」ページが表示されます。

  4. テキストフィールドを使用して必要な変更を行います。

  5. 編集が完了したら、ページの最下部近くにある「save」ボタンをクリックします。

    HTML ユーザーインタフェースでは変更が保存され、「session variables」ページが表示されます。

  6. 変更を取り消すには、ページの最下部近くにある「cancel」ボタンをクリックします。

    変更は保存されず、HTML ユーザーインタフェースには「session variables」ページが表示されます。

プランの実行

プランをチェックインしたら、ホストに操作を行うため、プランを実行することができます。

Procedure実行中のプランを表示する

手順
  1. 左側のナビゲーションメニューで、「plans」をクリックします。

    HTML ユーザーインタフェースには、すでにデータベースにチェックインされているプランを一覧表示する、「plans」ページが表示されます。

  2. 目的のプランがある行を見つけ、「details」をクリックします。

    HTML ユーザーインタフェースには、そのプランの「Plan Details」ページが表示されます。

  3. ページの最下部近くにある「run」ボタンをクリックします

    HTML ユーザーインタフェースには「Plan Details Run」ページが表示されます。

  4. 必要な情報を入力し、「run preflight only」をクリックしてプランが正しく実行されることを確認するか、「run plan (includes preflight)」をクリックして、プランを実行します。

Procedureコンポーネントの直接実行手続きを使用する

複数のコンポーネントやホスト間の同期が含まれない、単純な配備の場合は、プランを記述する必要がないこともあります。 その代わりに、配備するコンポーネントをチェックインすると プロビジョニングソフトウェア により自動的に生成される「直接実行」手続きの 1 つを使用することができます。

このような「直接実行」手続きの 1 つを実行するには、次の操作を行います。

手順
  1. 左側のナビゲーションメニューで、「components」をクリックします。

    HTML ユーザーインタフェースには、すでにデータベースにチェックインされているコンポーネントを一覧表示する、「components」ページが表示されます。

  2. コンポーネントがあるテーブルで、配備するコンポーネントを説明する行を見つけ、「details」をクリックします。

    HTML ユーザーインタフェースには、そのコンポーネントの「Components Details」ページが表示されます。

  3. 「component procedures」テーブルで、実行する手続きの名前の隣にあるチェックボックスをクリックしてから、「run」をクリックします。

    HTML ユーザーインタフェースには、その手続きの「Plan Details Run」ページが表示されます。

  4. ページ上のフィールドを使用して、変数を入力し、プランの実行時に使用するパラメータを選択します。

    • 「plan parameters」領域で、「target host field」フィールドを使用してこのプランの実行対象であるホストを選択するか、プルダウンメニューを使用してターゲットホストのセットを選択します。

    • 「plan variables」領域で、設定が必要な変数を設定します。 設定すべき変数が存在するかどうかは、プランの内容によって決まります。

    • 「options」領域で、詳細なプリフライトを実行するかどうかを選択します。 詳細なプリフライトを実行すると、プリフライトに要する時間が長くなりますが、プリフライトがより詳細になります。

    • 「limits」領域で、表示されているフィールドにホスト数を入力して、同時に実行するホストの数を制限します。 表示されているフィールドに数を入力し、プルダウンメニューから「minutes」などの時間の単位を選択することで、プラン全体の実行時間を制限したり、ネイティブ呼び出しの実行時間を制限することもできます。

  5. 次のいずれかの操作を行います。

    • 手続きのプリフライトテストのみを実行するには、「run preflight only」をクリックします。

    • プリフライトテストを実行してから、プリフライトテストでエラーがなかったという前提で手続き自体を実行するには、「run plan (includes preflight)」をクリックします。

CLI コマンドの概要

表 6–2 に、プランの実行に関連付けられた CLI コマンドの説明を示します。

表 6–2 pe コマンドの概要

コマンド 

説明 

pe.h.prep 

ホストのセットを準備する。 

pe.p.en 

execNative ステップの出力を表示する。 

pe.p.la 

実行中および完了したプランを一覧表示する。 

pe.p.lo 

実行中または完了したプランに関する情報を一覧表示する。 

pe.p.del 

完了したプラン実行の履歴を削除する。 

pe.p.lp 

プランに関連付けられたサブプランとターゲットを一覧表示する。 

pe.p.run 

プランを実行する。 

pe.p.stop 

実行中のプランを停止する。 

pe.pi.lo 

プランの実行に使用されるパラメータを一覧表示する。