N1 Service Provisioning System 4.1 リファレンスガイド

param 要素

<param> 要素は <paramList> 要素の子であり、パラメタ (名前、デフォルト値など) の宣言に使用されます。 デフォルト値が使用されるのは、呼び出し側がこのパラメタの値を明示的に渡さない場合だけです。 デフォルト値が指定されず、呼び出し側がこのパラメタの値を明示的に渡さない場合、プランの実行時にプリフライトエラーが発生します。

param 要素には、オプションの prompt および displayMode 属性が含まれます。これらの属性は、包含しているインストールブロック、アンインストールブロック、または制御ブロックがプランまたはほかのコンポーネントからではなくクライアントによって直接呼び出される場合に使用されます。

param 要素属性

名前 

型 

必須 

構成可能 

説明 

name 

identifier 

はい 

不可 

パラメタの名前。 この名前は、包含要素によって宣言されているすべてのローカル変数とパラメタにおいて一意のものでなければならない 

prompt 

文字列 

いいえ 

不可 

パラメタの値を求める際に表示する UI テキスト。 指定しないと、デフォルトで名前が使用される 

default 

文字列 

いいえ 

可能 

パラメタのデフォルト値。これには、コンポーネント変数、対象ホスト属性、およびインストール済みのコンポーネント変数を含めることができるが、ほかのパラメタを含めることはできない  

display Mode 

次の 1 つ: 

PASSWORD 

CLEAR 

BOOLEAN 

いいえ 

不可 

パラメタの表示モード  

指定しないと、デフォルトで CLEAR が使用される 

PASSWORD を指定すると、クライアントが入力した値が隠される (非表示、*** への置換など)  

BOOLEAN を指定すると、チェックボックスを使用してパラメタの入力が行われる  

あるいは、CLEAR または BOOLEAN を指定した場合に、入力時に値を表示するようにすると安全