クライアント・パラメーター・リスト・パラメーター

オンライン編集

クライアント・パラメーター・リストを使用すると、単一の要求で複数の項目に対してサービスを実行できます。 NSM サービス設計者 は、 <clientParameterList> エレメントと name 属性を使用して、 NSM サービス・テンプレートを設計する際のクライアント・パラメーター・リストの名前を定義します。 NSM サービス設計者 は、 <parameter name> タグを使用して、そのリスト内にパラメーターを定義します。 NSM クライアント・ユーザーは、 NSM サービス・テンプレートをサブミットするときに、 <values> タグと </values> タグ、および order 属性を使用して、値とその値の評価順序を指定します。

以下のサンプル XML は、 NSM サービス・デザイナー が NSM サービス・テンプレートの作成時に指定する <clientParameterLists> エレメントおよび関連付けられたタグのレイアウトを示しています。

<clientParameterLists>
	<clientParameterList name="ZONEID" description="Zone ID">
		<parameter name="ZONE_NAME" description="Zone Name"/>
	</clientParameterList>
	<clientParameterList name="ROUTEDETAILS" description="Route Details">
		<parameter name="SOURCEROUTETABLE" description="Source Route Table"/>
		<parameter name="TARGETROUTETABLE" description="Target Route Table"/>
		<parameter name="VIRTUALROUTERNAME" description="Virtual Route Table"/>
	</clientParameterList>
</clientParameterLists>

以下のサンプル XML は、 NSM サービス・テンプレート を実行依頼するときに NSM クライアント・ユーザーが指定する <value> タグの使用法を示しています。

.
.
.
<clientParameterLists>
	<clientParameterList name="ZONEID">	
<parameter name="ZONE_NAME"/>
 </clientParameterList>
 <clientParameterList name="ROUTEDETAILS">
	<parameter name="SOURCEROUTETABLE"/>
  	<parameter name="TARGETROUTETABLE"/>  
	<parameter name="VIRTUALROUTERNAME"/> 
 </clientParameterList>
</clientParameterLists>

<clientParameterLists>
<clientParameterList name="ZONE_NAME_ID">
<parameter name="ZONE_NAME">
<values>
<value order="1">Cisco_Zone_Name1</value>
<value order="2">Cisco_Zone_Name2</value>
.
.
.

表 1 では、 NSM サービス・テンプレート 設計および NSM サービス・テンプレート 実行依頼のためのクライアント・パラメーター・リスト・パラメーター・エレメントおよび関連タグについて説明します。

表 1. NSMサービステンプレートの設計と提出のためのクライアントパラメータリストのパラメータ要素とタグの詳細
エレメント/タグ タイプ 説明
<clientParameterLists> 包含リスト

クライアント・パラメーター・リストとそれに関連したパラメーターが入っています。 各クライアント・パラメーター・リストおよび関連パラメーターは、 <clientParameterLists> </clientParameterLists> エレメント・ペア内にカプセル化されます。

この例では、 <clientParameterLists> エレメントに ZONEID と ROUTEDETAILSの 2 つのクライアント・パラメーター・リストが含まれています。
<clientParameterList> コンテナー

クライアント・パラメーター・リストの定義 (パラメーター名と説明) が入っています。 各クライアント・パラメーター・リスト定義は、 <clientParameterList> </clientParameterList> エレメント・ペア内にカプセル化されます。
clientParameterList.name ストリング

name 属性は、クライアント・パラメーター・リストの名前 (別名) を指定します。 この名前は、指定された操作に使用されるパラメーターを選択するために、 <operation> タグ内のパラメーター・リストで使用される ID です。

この例では、 <clientParameterList> エレメントと description 属性の 2 つのインスタンスを使用して、2 つのクライアント・パラメーター・リスト記述 ( 「ゾーン ID」 と 「経路詳細」) を指定します。
clientParameterList.description ストリング

description 属性は、クライアント・パラメーター・リストの説明を指定します。

この例では、 <clientParameterList> エレメントと name 属性の 2 つのインスタンスを使用して、2 つのクライアント・パラメーター・リスト ( ZONEID と ROUTEDETAILS) を定義します。
<parameter> コンテナー

サービス操作で使用される 1 つ以上のクライアント・パラメーターが含まれます。 各クライアント・パラメーターは、 <parameter> </parameter> タグのペア内にカプセル化されます。
parameter.name ストリング

name 属性は、 Netcool Configuration Managerにサブミットする値の設定に使用するパラメーターの名前を指定します。

この例では、 <parameter> タグと name 属性のインスタンスを使用して作成します。

  • ZONEID パラメーター・リストの場合: ZONE_NAMEと呼ばれる 1 つのパラメーター。
  • ROUTEDETAILS パラメーター・リストの場合: SOURCEROUTETABLE、 TARGETROUTETABLE、および VIRTUALROUTERNAMEと呼ばれる 3 つのパラメーター。
parameter.description ストリング

description 属性は、パラメーターの説明を指定します。

この例では、 <parameter> タグと description 属性のインスタンスを使用して、以下のパラメーター記述を作成します。

  • ZONEID パラメーター・リストの場合: ZONE_NAME という 1 つのパラメーターと Zone IDの説明。
  • ROUTEDETAILS パラメーター・リストの場合: SOURCEROUTETABLE という 3 つのパラメーター ( ソース経路テーブルの説明付き)、 TARGETROUTETABLE ( ターゲット経路テーブルの説明付き)、および VIRTUALROUTERNAME ( 仮想経路テーブルの説明付き)。
<values> 包含リスト

<value> タグのリストが入っています。 これは、1 から複数までの範囲にすることができます。 パラメーター・リスト内で定義されたすべての <value> タグは、 <values> </values> タグのペア内でカプセル化されます。

注: NSM クライアント・ユーザーは、クライアント・パラメーター・リスト・パラメーターに適切な値を取り込む際に、 <values> タグと <value> タグ、および <order> 属性を使用します。 NSM クライアント・ユーザーは、 NSM サービス・テンプレート を実行依頼するときに、これらのタグと属性を指定します。 1 つのクライアント・パラメーター・リストに複数の値を割り当てることができます。 このクライアント・パラメーター・リスト名を使用する操作は、割り当てられた値と同じ回数だけ実行されます。
<value> コンテナー

サービス操作に提供される値が含まれます。

この例では、 <value> タグの 2 つのインスタンスを使用して、2 つの値 Cisco_Zone_Name1 および Cisco_Zone_Name2を定義します。
value.order ストリング

値がどの順序で表示されるかを表す数値。 この属性はオプションです。 同じ操作で設定する必要がある値が保証されるため、order 属性を使用することをお勧めします。 例えば、2 つの <clientParameterList> エレメントに 2 つのパラメーターがある場合、最初のパラメーターが 2 番目の <clientParameterList> の最初のパラメーターとペアになるようにするには、このペア化を保証するために order 属性を使用する必要があります。

この例では、 order 属性の 2 つのインスタンスを使用して値の順序を定義します。 Cisco_Zone_Name1 が最初に評価され、次に Cisco_Zone_Name2が評価されます。