CLI Configlet ワークフロー

CLI Configlet は、CLI Configlet ワークスペースから定義できます。表 1 は、CLI Configlet に対して定義されるパラメーターを示しています。

表 1:CLI 構成レットのパラメーター
パラメーター	説明
名前	CLI 構成レットの名前。名前は 255 文字を超えることはできません。使用できる文字には、ハイフン(-)、アンダースコア(_)、文字、数字、ピリオド(.)が含まれます。同じ名前のコンフィグレットを 2 つ持つことはできません。
カテゴリ	CLI 構成レットのカテゴリー。カテゴリーは 255 文字を超えることはできません。使用できる文字には、ハイフン(-)、アンダースコア(_)、文字、数字、ピリオド(.)が含まれます。
デバイスファミリーシリーズ	CLI Configlet が適用可能なデバイスファミリーシリーズ。
コンテキスト	CLI 構成レットが適用されるコンテキスト。これはオプションのフィールドです。
説明	CLI 構成の説明。説明は 2,500 文字を超えることはできません。これはオプションのフィールドです。
プレビューオプション	[パラメータを表示]オプションを選択すると、CLI Configletに存在するパラメータが表示されます。[設定の表示] オプションは、CLI Configlet が適用される前に統合された設定を表示します。
ポストビューオプション	[パラメータを表示]オプションを選択すると、CLI Configletに存在するパラメータが表示されます。[設定の表示] オプションは、CLI Configlet が適用された後の統合設定を表示します。
構成内容	実際のCLI構成はここで定義されていますCLI Configlet には複数のページを含め、タブ状の構造に従います。デバイスに適用される設定は、複数のページに分割できます。設定が適用されると、すべてのページがページ番号の順に結合され、1 回のコミット操作でデバイスに適用されます。次のページに移動する前に、必ずCLI構成を検証する必要があります。
リファレンスナンバー	値の範囲は 1~^{216 です}。

メモ：

CLI 構成の内容が無効な場合、次のページに移動することはできません。検証にはブラケットの照合が含まれます。

パラメーターは、CLI Configlet で定義された変数で、その値は環境から取得されるか、実行時にユーザーによって入力されます。ユーザーが CLI Configlet を適用すると、CLI Configlet で定義されているすべての変数の入力値を要求されます。

パラメータを設定するには、ツールバーの変更アイコンをクリックします。「構成パラメーターの編集」ページが表示されます。このページを使用して、パラメーターの属性を設定します。

追加のパラメータを追加するには、ツールバーの追加アイコンをクリックします。[構成パラメーターの追加] ページが表示されます。パラメーターの属性は、このページから設定されます。

パラメータを削除するには、ツールバーの削除アイコンをクリックします。デフォルトでは、CLI Configlet に存在するすべての変数が[パラメータ]ページに表示されます。ローカル変数は手動で削除するか、「不可視」タイプに設定する必要があります。

表 2 は、CLI Configlet パラメーターの属性を示しています。

表 2:CLI Configlet パラメーターの属性
CLI Configlet パラメータ属性	説明
パラメーター	パラメーターの名前形式でネーム・スペースと一緒に `<configlet name>.<parameter.name>` 表示された場合、このパラメーターは組み込まれた CLI Configlet に属します。
表示名	パラメーターの表示名
説明	パラメーターの説明
種類	サポートされるパラメーターのタイプは次のとおりです。 `Text field` – CLI Configlet を実行する際にカスタム値を指定できます。このフィールドのデフォルト値は、「構成値 Xpath」フィールドに XPath を使用するか、「デフォルト値」フィールドにプレーン・ストリングを使用して構成できます。これは、単一の値を返します。 `Selection field` – このCLI Configletを実行する際に、一連のオプションから値を選択できます。このフィールドのデフォルト値は、「構成値 Xpath」フィールドに XPath を使用するか、「デフォルト値」フィールドにプレーン・ストリングを使用して構成できます。オプションは、[選択値 Xpath] フィールドの XPath または [選択値] フィールドで CSV 文字列を使用して設定できます。これは、単一の値を返します。メモ：これは単一の値を返しますが、戻り値は配列型の値であり、選択した値はインデックス0から取得できます。 `Invisible field` – このフィールドは編集できません。このパラメーターは、[既定値] フィールドまたは [構成値 Xpath] フィールドの XPath で CSV 文字列として明示的に定義された値を参照します。このフィールドは、値の配列を返します。 `Password field` – パラメーターを含む CLI Configlet を適用する場合は、値を入力する必要があります。これにより、CLI 構成の適用ジョブの結果で機密情報が非表示になります。 `Password Confirm field` – パラメーターを含む CLI Configlet を適用する場合、値を 2 回入力する必要があります。これにより、CLI 構成の適用ジョブの結果で機密情報が非表示になります。
設定値 XPath	このフィールドは、設定値の XPath を指定するために使用されます。このフィールドの動作は、パラメーターのタイプによって異なります。パラメーター・タイプがテキスト・フィールドまたは選択フィールドである場合、XPath に存在する対応する値がデフォルト値として取り込まれます。この値は変更できます。XPath が複数の値を返す場合、返される最初の値が考慮されます。パラメーター・タイプが不可視フィールドの場合、XPath によって戻される値のリストがパラメーターの値として取り込まれます。 [非表示] フィールドには、パラメータースコープがデバイス固有またはエンティティ固有の場合にのみ、XPath と選択値 XPath が設定されています。スコープがグローバルの場合、これは無効になります。メモ： $INTERFACE、$UNIT、構成値 Xpath フィールド、不可視フィールド、および選択フィールドを使用する場合、Configlet エディターの変数定義は、配列から値をフェッチするために含める `.get(0)` 必要があります。たとえば、$INTERFACE.get(0)
デフォルト値	値が明示的に指定されていることを除き、[構成値 Xpath] フィールドと同じ動作を表示します。このフィールドは、設定値 XPath が指定されていない場合、または XPath が値を戻さない場合にのみ考慮されます。
選択値 XPath	このフィールドは、パラメータータイプが [選択] フィールドの場合にのみ有効になります。このフィールドには、選択フィールドの値セットをフェッチするための XPath(デバイス XML を参照)が含まれています。
選択値	このフィールドは、値が明示的に指定されていることを除いて、選択値 XPath フィールドと同じです。このフィールドは、選択値 XPath が指定されていない場合、または XPath が値を戻さない場合にのみ考慮されます。メモ：カンマ区切り値を使用して、[既定値] フィールドと [選択値] フィールドに値の配列を指定できます。メモ： XPath を定義する際には、関数を使用してテキストノードに直接アクセスする `text ()` 必要があります。それ以外の場合は、ノードの完全な XML パスが返されます。たとえば、 /device/interface-information/physical-interface/name/text() を使用して、すべてのインターフェイスの名前をフェッチします。
順序	パラメーターの順序。これは、実行時にユーザー入力に対してフィールドを表示する必要がある相対的な順序です。
正規表現値	このフィールドには、CLI Configlet をデバイスに適用する際にパラメーター値の検証に使用されるパラメーターの正規表現が含まれています。
読み取り専用	パラメーターが基本構成部または組み込み構成レットのいずれに属する場合でも、以下のようになります。 false – このパラメーターは基本構成セットに属します。 true – このパラメーターは、含まれている構成レットに属します。この構成レットからパラメーターを変更または削除することはできません。

CLI Configlet ワークフロー

関連ドキュメント