Cisco VMS 拡張機能

この章では、VMS サービス拡張機能の概要を説明し、サービスウィンドウにサービス拡張機能テンプレートを作成、インポート、適用するプロセスについても説明します。

この章は、次の内容で構成されています。

Cisco VMS のサービス拡張を理解する

VMS のサービス拡張は、設定スニペットをサービスまたはデバイスに適用する方法を簡略化します。VMS は、Cisco ネットワークサービスオーケストレータ (NSO) カスタムテンプレートの基盤となる機能を利用します。このテンプレートは、派生した構成テンプレートともにプッシュされます。サービス拡張はほとんどの場合、追加のプログラミングを必要とせずに、サービスをデバイス構成にマップするために使用できます。

VMS サービス拡張テンプレートは、変数を使用して、サービス属性を対応するデバイス構成にマップするとともに、適用されます。サービス拡張機能は、このような操作を記述する宣言方法を許可します。VMS のオペレータは、手動で NSO CLI を操作しなくても、サービス拡張テンプレートをVMS 内の既存のサービスチェーンまたはデバイスに適用できます。このサービス拡張テンプレートは、NSO が構成をデバイスにプッシュする前に、サービス構成スニペットを追加、変更、または削除するため、NSO によって使用されます。

VMS サービス拡張テンプレートは、サービス注文ワークフローまたは単一のデバイスに適用できます。VMS にサービス拡張テンプレートをインポートする際には、テンプレートをワークフローまたはデバイスのどちらに適用するかを指定することができます。

サービス拡張テンプレートをサービス注文ワークフローに適用すると、VMS サービスワークフローは、サービス注文プロセス中にテナントユーザが入力値を収集します。これらの値は NSO に渡され、デバイスの構成のためにさらに利用されます。

次の図は、VMS でサービス拡張テンプレートを扱う際に従う必要のある、エンドツーエンドのワークフローを描いています。

VMS サービス拡張テンプレート XML ファイルの作成

VMS サービス拡張テンプレートは XML ファイルです。そのファイルの構造は YANG モデルによって定義されます。

テンプレートの定義の基本原則としては、次のものがあります:

テンプレートは、デバイスツリー内のノードに対応する XML ファイル (たとえば mytemplate.xml ) です。
テンプレート内のそれぞれの値は、文字列として保存されます。この文字列値は、テンプレートが適用されたとき、YANG モデルの実際の値の型に変換されます。
設定する必要がある XML タグの値の部分は、変数名に「$」リテラルを付けて表す必要があります。
テンプレートでは、テンプレートを適用するときに別の動作を定義することができます。これは merge、replace、delete、create または nocreate といったタグを、テンプレートの関連するノードに設定することによって行います。

たとえば、デバイスで NTPサーバを設定するテンプレートを作成する場合は、サンプルのテンプレート XML ファイルは次のようになります:

<config
    xmlns="http://tail-f.com/ns/config/1.0">
    <device
        xmlns="http://tail-f.com/ns/ncs">
        <name>ntp</name>
        <config tags="merge">
            <system xmlns="http://pica8.org/yang">
                <ntp-server-ip>{$NTP}</ntp-server-ip>
            </system>
            <ntp xmlns="urn:ios">
                <server>
                    <server-list>
                        <ip-address>{$NTP}</ip-address>
                    </server-list>
                </server>
            </ntp>
        </config>
    </devices>
</config>

サービス拡張テンプレートを作成したら、次を実行する必要があります：

NSO にテンプレート XML ファイルをインポートします。詳細については、テンプレート XML ファイルを NSO へインポートするを参照してください。

VMS にテンプレート XML ファイルをインポートします。詳細については、VMS ポータルでサービス拡張を作成するを参照してください。

テンプレート XML ファイルを NSO へインポートする

NSO にテンプレート XML ファイルをインポートするには、次の手順が必要です:

手順

ステップ 1

Cisco ネットワークサービスオーケストレータ (NSO) サーバにログインします。

ステップ 2

カスタムテンプレートフォルダを作成します (最初の場合のみ)。

admin@ncs%sudo mkdir /var/opt/ncs/packages/custom-templates/templates/

ステップ 3

package-meta-data.xml ファイルを /var/opt/ncs/packages/custom-templates フォルダに作成します (最初の場合のみ)。

admin@ncs%sudo vi package-meta-data.xml   <== copy content below

<ncs-package
    xmlns="http://tail-f.com/ns/ncs-packages">
    <name>custom-templates</name>
    <package-version>1.0</package-version>
    <description>Custom template store</description>
    <ncs-min-version>4.1</ncs-min-version>
</ncs-package>

ステップ 4

package-meta-data.xml ファイルの内容を確認します (最初の場合のみ)。

admin@ncs%/var/opt/ncs/packages$ cat /var/opt/ncs/packages/custom-templates/package-meta-data.xml 

<ncs-package
    xmlns="http://tail-f.com/ns/ncs-packages">
    <name>custom-templates</name>
    <package-version>1.0</package-version>
    <description>Custom Template Store</description>
    <ncs-min-version>4.1</ncs-min-version>
</ncs-package>

ステップ 5

サービス拡張カスタムテンプレートを NSO に追加します。場所は /var/opt/ncs/packages/custom-templates/templates フォルダになります。

ステップ 6

NSO カスタムテンプレートを有効にします:

admin@ncs%set globals custom-template true
admin@ncs%commit

ステップ 7

NSO をリロードします。

admin@vms-ncs-tmepoc1-sm% request packages reload

（注）

NSO をリロードしたら、 /var/opt/ncs/packages/custom-templates/templates フォルダに新しいテンプレートに存在することを確認します。
パッケージがリロードしたら、すべての CLI セッションが動作モードであること、どれも設定モードで開かれてはいないことを確認します。

プロバイダ、テナントグループまたはテナント用のサービス拡張パラメータの定義

VMS にサービス拡張テンプレートをインポートする際、オペレータは、サービス拡張パラメータごとにメタデータを指定する必要があります。さらに、これらのパラメータのいくつかの値は、サービスプロバイダまたはテナントのすべてのデバイス間で共通なものである可能性があります。Cisco VMS 3.1 以降では、サービス拡張テンプレートをインポートするとき、メタデータとデフォルト値をサービス拡張パラメータにマッピングすることができます。これは、テンプレートインポートプロセスで、テンプレートパラメータを、事前に定義されたサービス拡張プロバイダまたはテナントパラメータにマッピングすることで行われます。サービス拡張機能のパラメータの 3 つのタイプは、次のとおりです:

プロバイダパラメータ - サービスプロバイダのレベルで定義します。プロバイダパラメータは、すべてのテナント間で使用できます。
テナントグループパラメータ - サービスプロバイダのレベルで定義されますが、デフォルト値はテナントグループごとに設定できます。

テナントパラメータ - サービス拡張デザイナが定義し、デフォルト値はテナントごとに設定できます。

（注）

テナントサービス拡張パラメータを定義するときには、パラメータをテナントまたはテナントグループを関連付ける必要があります。そして、テナントまたはテナントグループごとに個別のデフォルト値を設定することができます。詳細については、サービス拡張テナントパラメータのデフォルト値を指定するを参照してください。

サービス拡張パラメータには、次の利点があります:

サービスプロバイダまたはテナントグループまたはテナントレベルで定義できます。
パラメータはテンプレート XML ファイルを VMS にインポートするときに自動マッピングされ、パラメータメタデータは継承されます。
優先順位の順序に従います — 最初のテナントパラメータが存在する場合、それを使用します。そうでなければ、プロバイダパラメータが使用されます。
サービス注文プロセスでは、プロバイダまたはテナントパラメータのデフォルトパラメータ値を設定します。

サービス拡張パラメータを定義するには、次の必要があります:

手順

ステップ 1

シスコ VMS ポータルにログインします。

（注）

Cisco 仮想マネージドサービスには、新たな事前に定義済みロールである、サービス拡張デザイナが含まれるようになりました。サービス拡張デザイナは、サービス拡張テンプレートのインポート、サービス拡張パラメータの定義、デフォルトのパラメータ値の定義などが行えます。

ステップ 2

左側にあるメニューで、[Setting]、そして [Extensions] を選択します。

ステップ 3

サービスプロバイダレベルのパラメータを追加するには、次の操作を行います。

[プロバイダ] タブをクリックします。
[Add Extension Parameter] ボタンをクリックします。
パラメータ名を入力します。
VMS ポータルに表示されているパラメータラベルを入力します。
入力タイプを選択します。
表示タイプを選択します。
パラメータのデフォルト値を入力します。
[Save] をクリックします。

ステップ 4

テナントグループのパラメータを追加するには、次の操作を行います:

[Tenant Group] タブをクリックします。
[Add Extension Parameter] ボタンをクリックします。
パラメータ名を入力します。
VMS ポータルに表示されているパラメータラベルを入力します。
入力タイプを選択します。
表示タイプを選択します。
[Save] をクリックします。

ステップ 5

テナントレベルのパラメータを追加するには、次の操作を行います:

[Tenant] タブをクリックします。
[Add Extension Parameter] ボタンをクリックします。
パラメータ名を入力します。
VMS ポータルに表示されているパラメータラベルを入力します。
入力タイプを選択します。
表示タイプを選択します。
[Save] をクリックします。

サービス拡張テナントパラメータのデフォルト値を指定する

サービス拡張テナントパラメータを定義するときには、テナントごとにデフォルト値を指定する必要があります。このデフォルト値は、サービス拡張テンプレートがサービスワークフローに適用されるとき、パラメータにより継承されます。

サービス拡張テナントパラメータの値を指定するには、以下の手順に従う必要があります:

サービス拡張パラメータのデフォルト値を指定する

手順

ステップ 1

シスコ VMS ポータルにログインします。

（注）

ステップ 2

左側にあるメニューで、[Tenants] を選択します。

[Manage Tenants] 画面が表示されます。

ステップ 3

パラメータのデフォルト値を指定するには、リストでテナントユーザを選択し、[Edit] アイコンをクリックします。

ステップ 4

サービス拡張パラメータのデフォルト値を指定します。

ステップ 5

[Save] をクリックします。

テナントグループのサービス拡張パラメータのデフォルト値を指定する

手順

ステップ 1

シスコ VMS ポータルにログインします。

（注）

ステップ 2

左側にあるメニューで、[Tenants Group] を選択します。

[Manage Tenants Groups] グループ画面が表示されます。

ステップ 3

パラメータのデフォルト値を指定するには、リストでテナントユーザを選択し、[Edit] アイコンをクリックします。

ステップ 4

サービス拡張パラメータのデフォルト値を指定します。

ステップ 5

[Save] をクリックします。

VMS ポータルでサービス拡張を作成する

VMS にサービス拡張テンプレートをインポートするには、グローバルなサービス拡張またはテナントグループまたはテナントパラメータを定義します。詳細については、プロバイダ、テナントグループまたはテナント用のサービス拡張パラメータの定義を参照してください。

サービス拡張を作成するには、以下の手順に従います:

手順

ステップ 1

Cisco VMS ポータルにログインします。

（注）

Cisco 仮想マネージドサービスには、新たな事前に定義済みロールである、サービス拡張デザイナが含まれるようになりました。サービス拡張デザイナーは、サービス拡張テンプレートのインポート、サービス拡張パラメータの定義、デフォルトのパラメータ値の定義などをを行えます。

ステップ 2

左側にあるメニューで、[Configurations] を選択します。

ステップ 3

サービス拡張テンプレートにインポートするサービスをクリックします。

ステップ 4

[Service Extensions] タブをクリックします。

ステップ 5

[Add Service Extension] ボタンをクリックします。

ステップ 6

[Upload File] ボタンをクリックして、サービス拡張テンプレート XML ファイルをインポートします。

（注）

テンプレート名は、NSO にアップロードされた名前を正確に一致する必要があります。

ステップ 7

テンプレート名とその説明を入力します。

ステップ 8

[Next] をクリックします。

ステップ 9

次のいずれかを実行します:

すべてのテナントにテンプレートを適用するには、[All Tenants] を選択します。
特定のテナントにテンプレートを適用するには、[Specific Tenants] を選択し、1 つ以上のテナントを選択します。

ステップ 10

サービス拡張の適用先である XPATH を指定します。詳細については、次の表を参照してください。

サービスパック

XPATH

デバイスタイプ

cVPN サービスパック

/cloudvpn

ハブルータ

/cloudvpn/cpe

CPE

/cloudvpn/firewall

ASA ファイアウォール

/cloudvpn/wsa

WSA サービス

/cloudvpn/cpe[id='{DEVICE-ID}']

（注）

この XPATH は、デバイステンプレートに対して指定する必要があります。

対応するデバイス

IWAN サービスパック

/iwan/hub-sites/

ボーダルータ

/iwan/hub-sites/

マスターコントローラ

/iwan/sites/cpes

ブランチデバイス

/iwan/sites[./name='SITE2']/cpes

ブランチデバイス SITE2 のみ

/iwan/sites[(name, 'SITE1') を含む]/cpes

“SITE1” を含むブランスデバイス名

/iwan/hub-sites/border-routers[name='{$ROUTER-ID}']

特定のルータ

/iwan/sites/cpes[name='{$CPE-ID}']

（注）

この XPATH は、デバイステンプレートに対して指定する必要があります。

対応するデバイス

ステップ 11

サービス拡張テンプレートをサービス注文またはデバイスに適用するには、次のいずれかの操作を行います:

サービス拡張テンプレートをサービス注文に対して有効にするには、 [Yes] を選択します。
サービス拡張テンプレートをデバイスに対して有効にするには、[No] を選択します。

ステップ 12

[Next] をクリックします。

サービス拡張のパラメータが表示されます。

パラメータ名が定義済みのサービス拡張パラメータとマッチする場合には、VMS はテンプレートパラメータを自動マップします。プロバイダ、テナントグループまたはテナント用のサービス拡張パラメータの定義を参照してください。

（注）

サービス拡張をデバイスで有効にする場合には、デバイスに対してサービス拡張パラメータを定義する必要はありません。。このシナリオでは、ステップ 13、14 をスキップして、ステップ 15 に直接進んでください。

ステップ 13

パラメータの自動マッピング属性を編集するには、パラメータをクリックして、次の操作を行います:

[Function Pack Context] チェックボックスをオンにします。

（注）

[Function Pack Context] チェックボックスをオンにすると、拡張を適用しても、パラメータはフォーム内では見えなくなります。値は NSO で解決されることになります。
チェックボックスをオンにしなかった場合、値はユーザにより提供されることになります。これは値を定義済みの (プロバイダ、テナント、テナントグループ) パラメータにマッピングすること、または拡張の適用時に提供することのいずれかにより行われます。

自動マッピングの関連付けを解除するには、[Edit extension parameter mapping] リンクをクリックします。
[Done] をクリックします。

ステップ 14

サービス拡張パラメータの入力タイプおよび表示タイプの属性を指定します。

（注）

パラメータの入力タイプおよび表示タイプの属性が指定されていない場合、それはサービス注文フォームのテキストフィールドと見なされます。

ステップ 15

[Save and Enable] をクリックします。

サービス拡張テンプレートは、サービスを注文する顧客が使用できます。

デバイス上のサービス拡張

VMS サービス拡張テンプレートをサービス注文ワークフローに適用することに加えて、Cisco VMS には、これらのテンプレートをデバイスに適用する機能も用意されています。サービス拡張テンプレートを VMS にインポートする際には、テンプレートをサービスワークフローまたは単一のデバイスのどちらに適用するかを指定できます。

サービスの注文後にサービス拡張テンプレートをデバイスに適用すると、サービス拡張テンプレートはサービス注文ワークフロー外部のデバイスに適用され、個々のデバイスを使用する際に利用できるようになります。次の表では、サービス拡張テンプレートをデバイスに適用する前に実行するべきいくつかの手順を、リストにして表示しています。


手順	関連するセクション	注意
1. VMS サービス拡張テンプレートの XML ファイルを作成します。	VMS サービス拡張テンプレート XML ファイルの作成
2. テンプレートの XML ファイルを NSO にインポートします。	NSO にテンプレート XML ファイルをインポートする
3. VMS ポータルでサービス拡張を作成します。	VMS ポータルでのサービス拡張の作成	この手順を実行する際には、次の点を確認してください: サービス拡張を適用するデバイスの XPATH を指定します。たとえば、IWAN の XPATH には、`/iwan/hub-sites/border-routers[name=’{$ID}’` またはサービス拡張を適用する他のデバイスを指定できます。XPATH 内のデバイス ID の $ パラメータは、サービス拡張を自動的にデバイス拡張に変換します。サービス拡張テンプレートをデバイスに対して有効にするには、サービス注文のためのサービス拡張テンプレートオプションを 'No' に設定します。ステップ 13、14 をスキップして、ステップ 15 に直接進みます。デバイスに対応するサービス拡張パラメータを定義することは必須ではないからです。
4. サービス拡張をデバイスに適用します。	デバイスにサービス拡張を適用する

デバイスにサービス拡張を適用する

サービス拡張テンプレートをデバイスに適用するには。

手順

ステップ 1	Cisco VMS Portal にログインします。
ステップ 2	[サービスインターフェイス (Service Interface)] の左側のペインから、[デバイス (Devices)] をクリックして、[デバイスの登録 (Register Device)] ウィンドウで購入したデバイスのリストを表示します。
ステップ 3	サービス拡張テンプレートを適用するデバイスをクリックし、[デバイスの拡張 (Device Extensions)]をクリックします。 [デバイスの拡張 (Device Extensions)] ダイアログボックスが表示されます。
ステップ 4	サービス拡張をクリックし、対応するパラメータ値を指定します。
ステップ 5	[更新 (Update)] をクリックします。

Cisco 仮想マネージドサービス (VMS) 3.3 プラットフォームユーザガイド

偏向のない言語

翻訳について

Book Title

Cisco 仮想マネージドサービス (VMS) 3.3 プラットフォームユーザガイド

Chapter Title