エイリアス、注釈、およびタグ
オブジェクトの識別、アドレス指定、およびグループ化を簡素化するために、ACI は、ユーザがラベル メタデータをオブジェクトに追加するためのいくつかのメソッドを提供します。これらのメソッドは、以下のリストにまとめられています。
-
[名前エイリアス（Name Alias）]：GUI エンティティの表面的な代用。
-
[グローバル エイリアス（Global Alias）]：オブジェクトの識別名（DN）の代わりに使用できる、ファブリック内で一意のラベル。
-
[タグ インスタンス / 注釈（Tag Instance / Annotation）]：簡単なメモまたは説明。
-
[ポリシー タグ（Policy Tag）]：オブジェクトをグループ化するためのラベル。同じクラスである必要はありません。
Alias
ACI オブジェクト モデルでは、すべてのオブジェクトに一意の識別名（DN）があります。これは、親オブジェクト階層とそれ自体の名前を含む長い識別子であることがよくあります。たとえば、aepg35 という名前のアプリケーション エンドポイント グループを含む、ap13 という名前のアプリケーション プロファイルを含む Tenant2468 という名前のテナントについて考えてみます。APIC によって生成された、そのアプリケーション エンドポイント グループの DN は次のとおりです。uni/tn-Tenant2468/ap-ap13/epg-aepg35 これらの各オブジェクトが作成された後、ACI は通常、名前を変更することを許可しません。変更すると、名前が変更されたオブジェクトのすべての子孫オブジェクトの DN が変更されるためです。この不便さを克服するために、ACI は 2 つのエイリアス関数を提供します。GUI 用の名前エイリアスと API 用のグローバル エイリアスです。
名前エイリアス
名前エイリアス機能（または、設定が GUI に表示される場合は単に「エイリアス」）は、APIC GUI で表示されるオブジェクトの名前を変更します。基になるオブジェクト名は変更できませんが、管理者は、オブジェクト プロパティ メニューの [エイリアス（Alias）] フィールドに目的の名前を入力することにより、表示された名前を上書きできます。GUI では、name_alias (object_name) として、エイリアス名が括弧内に実際のオブジェクト名とともに表示されます。テナント、アプリケーション プロファイル、ブリッジドメイン、EPG などの多くのオブジェクト タイプは、エイリアス プロパティをサポートします。オブジェクト モデルでは、名前エイリアス
プロパティは objectClass.nameAlias です。たとえば、テナント オブジェクトのプロパティは fvTenant.nameAlias です。
前述のテナントの例を使用して、管理者がテナント名「Tenant2468」ではなく「AcmeManufacturing」を表示したいとします。Tenant2468 テナント プロパティの [エイリアス（Alias）] フィールドに優先名を入力すると、GUI は AcmeManufacturing (Tenant2468) を表示します。
名前エイリアス プロパティは、APIC GUI の単に表面的なものです。エイリアスはどの範囲でも一意である必要はなく、同じ値を他のオブジェクトの名前エイリアスとして使用できます。
グローバルエイリアス
グローバル エイリアス機能により、API の特定のオブジェクトのクエリが簡素化されます。オブジェクトを照会するときは、固有のオブジェクト ID（通常はオブジェクトの DN）を指定する必要があります。別の方法として、この機能を使用すると、ファブリック内で一意のラベルをオブジェクトに割り当てることができます。前の例を使用して、グローバル エイリアスを使用せずに、次の API リクエストを使用して DN でアプリケーション エンドポイントをクエリします。
GET: https://APIC_IP/api/mo/uni/tn-Tenant2468/ap-ap13/epg-aepg35.json
オブジェクト プロパティ メニューの [グローバル エイリアス（Global Alias）] フィールドで、より単純でありながら一意の名前を構成することにより、グローバル エイリアスを別の API コマンドとともに使用して、オブジェクトをクエリできます。
GET: https://APIC_IP/api/alias/global_alias.json
前の例を使用して、アプリケーション エンドポイント グループの構成プロパティの [グローバル エイリアス（Global Alias）] フィールドに「AcmeEPG35」と入力すると、クエリ URL は次のようになります。
GET: https://APIC_IP/api/alias/AcmeEPG35.json
APIC オブジェクト モデルでは、グローバル エイリアスは、エイリアスされるオブジェクトにアタッチされる子オブジェクト（tagAliasInst）です。前の例では、グローバル エイリアス オブジェクトは、アプリケーション エンドポイント グループ オブジェクトの子オブジェクトになります。
詳細については、『APIC REST API 構成ガイド』の「タグとエイリアス」の章を参照してください。
名前エイリアスまたはグローバル エイリアスの作成
この手順例は、テナントのアプリケーション プロファイルの名前エイリアスとグローバル エイリアスを作成する方法を示しています。他の多くのオブジェクトは、オブジェクトに移動した後、同じ手順を使用してこれらのエイリアス機能をサポートします。
手順
| ステップ 1 |
メニュー バーで [テナント（Tenants）] を選択し、該当するテナントを選択します。 |
| ステップ 2 |
[ナビゲーション（Navigation）] ペインで、 の順に選択します。 |
| ステップ 3 |
[Work] ペインで、[Policy] タブをクリックします。 アプリケーション プロファイルの [プロパティ（Properties）] ページが表示されます。 |
| ステップ 4 |
[エイリアス（Alias）] フィールドに、エイリアスの名前を入力します。 エイリアスは、どの範囲でも一意である必要はありません。 |
| ステップ 5 |
[グローバル エイリアス（Global Alias）] フィールドに、アプリケーション プロファイルの識別名（DN）のエイリアスを入力します。 グローバル エイリアスは、ファブリック内で一意である必要があります。 |
| ステップ 6 |
[送信（Submit）] をクリックします。 |
名前エイリアスを構成した場合、アプリケーション プロファイルは[ナビゲーション（Navigation）] ペインで alias（name） として識別されます。たとえば、[名前（Name）]が ap1234 で、SanJose として [エイリアス（Alias）] を構成した場合、アプリケーション プロファイルは SanJose（ap1234） として表示されます。
グローバル エイリアスを構成した場合、グローバル エイリアスをサポートする API コマンドで、アプリケーション プロファイルの識別名（DN）をその値に置き換えることができます。
注釈
メタデータの任意の key:value ペアを注釈（tagAnnotation）としてオブジェクトに追加できます。注釈は、説明、個人的なスクリプトまたは API 呼び出しのマーカー、または監視ツールまたは Cisco Multi-Site Orchestrator（MSO）などのオーケストレーション アプリケーションのフラグなど、ユーザのカスタム目的のために提供されます。APIC
はこれらの注釈を無視し、それらを他のオブジェクト データとともに格納するだけなので、APIC によって課される形式またはコンテンツの制限はありません。
注釈の進化
ユーザ定義の注釈情報の APIC サポートは、次の手順で時間の経過とともに変更されました。
-
Cisco APIC リリース 4.2(4) より前は、APIC は単純な文字列を格納するタグ インスタンス（
tagInst）をサポートしていました。APIC GUI メニューでは、これらは「タグ」としてラベル付けされていました。 -
Cisco APIC リリース 4.2(4) では、多くの最新のシステムがキーと値のペアをラベルとして使用しているため、API のメイン ラベル オプションとして key:value 注釈（
tagAnnotation）に移動するように変更が加えられました。タグ インスタンス（/api/tag/your_tag.json ）を介してオブジェクトをクエリするショートカット API は廃止されました。APIC GUI は、「Tags.」というラベルの付いた単純な文字列タグ インスタンス（tagInst）を引き続き使用していました。 -
Cisco APIC リリース 5.1(1) では、タグ インスタンス（
tagInst）は GUI で廃止されました。GUI メニューでは依然として「タグ」という用語が使用されていましたが、実際には注釈（tagAnnotation）が構成されていました。また、このリリース以降、すべての注釈のリストは、[ファブリック（Fabric）] > [ファブリック ポリシー（Fabric policies）] > [タグ（Tags）] から表示できます。 -
Cisco APIC リリース 5.2(1) では、GUI メニュー ラベルが「タグ」から「注釈」に変更されました。この変更は、ポリシー タグとの混同を避けるために行われました。
注釈の作成
この手順例は、テナントの注釈を作成する方法を示しています。他の多くのオブジェクトは、オブジェクトに移動した後、同じ手順を使用して注釈機能をサポートします。
手順
| ステップ 1 |
メニュー バーで [テナント（Tenants）] を選択し、該当するテナントを選択します。 |
| ステップ 2 |
[ナビゲーション（Navigation）] ペインで、を選択します。 |
| ステップ 3 |
[Work] ペインで、[Policy] タブをクリックします。 テナントのプロパティメニューが表示されます。 |
| ステップ 4 |
[注釈（Annotations）] の横にある [+] 記号をクリックして、新しい注釈を追加します。 |
| ステップ 5 |
注釈キー ボックスで、既存のキーを選択するか、新しいキーを入力します。 |
| ステップ 6 |
注釈値ボックスに値を入力します。 キーと値に使用できる英数字と記号は、a～z、A～Z、0～9、ピリオド、コロン、ダッシュ、またはアンダースコアです。 |
| ステップ 7 |
✓ 記号をクリックして注釈を保存します。 この手順を繰り返すと、注釈を追加できます。 |
ポリシー タグ
ポリシー タグ（tagTag ）、または単にタグは、ACI 機能で使用するためのユーザ定義可能なキーと値のペアです。1 つのオブジェクトに複数のタグを構成でき、複数のオブジェクトに同じタグを適用できます。多くのオブジェクト クラスがポリシー タグをサポートしているため、ポリシー
タグを使用して異なるオブジェクトをグループ化できます。たとえば、ポリシー タグを使用して、Cisco APIC リリース 5.2(1) の ESG タグ セレクターを使用して、エンドポイント、サブネット、および VM を 1 つのエンドポイント
セキュリティ グループ（ESG）としてグループ化できます。
ポリシー タグを使用する ACI 機能には次のものがあります。
-
エンドポイントセキュリティ グループ（ESG）
ポリシー タグの作成
この手順例は、静的エンドポイントのポリシー タグを作成する方法を示しています。他のいくつかのオブジェクトは、オブジェクトに移動した後、同じ手順を使用してポリシー タグをサポートします。
手順
| ステップ 1 |
メニュー バーで [テナント（Tenants）] を選択し、該当するテナントを選択します。 |
| ステップ 2 |
[ナビゲーション（Navigation）] ペインで、 の順に展開します。 |
| ステップ 3 |
[作業（Work）] ペインで、タグ付けする静的エンドポイントをダブルクリックします。 [静的エンドポイント プロパティ（Static Endpoint properties）] ダイアログボックスが表示されます。 |
| ステップ 4 |
[ポリシー タグ（Policy Tags）] の横にある [+] 記号をクリックして、新しいポリシー タグを追加します。 |
| ステップ 5 |
タグ キー ボックスで、既存のキーを選択するか、新しいキーを入力します。 |
| ステップ 6 |
タグ値ボックスにタグ値を入力します。 キーと値に使用できる英数字と記号は、a～z、A～Z、0～9、ピリオド、コロン、ダッシュ、またはアンダースコアです。 |
| ステップ 7 |
✓ 記号をクリックしてタグを保存します。 |
フィードバック